Skip to content

Freetz-NG/freetz-ng

 
 

Repository files navigation

Welcome to Freetz-NG

 _____              _            _   _  ____
|  ___| __ ___  ___| |_ ____    | \ | |/ ___|
| |_ | '__/ _ \/ _ \ __|_  /____|  \| | |  _
|  _|| | |  __/  __/ |_ / /_____| |\  | |_| |
|_|  |_|  \___|\___|\__/___|    |_| \_|\____|

Freetz-NG is a fork of Freetz. More features - less bugs!

Basic infos:

  • A web interface will be started on port :81, credentials: admin/freetz
  • Default credentials for shell/ssh/telnet access are: root/freetz
  • For more see: freetz-ng.github.io

Requirements:

Clone the main branch:

  git clone https://github.com/Freetz-NG/freetz-ng ~/freetz-ng

Or clone a single tag:

  git clone https://github.com/Freetz-NG/freetz-ng ~/freetz-ng --single-branch --branch TAGNAME

Install prerequisites:

  cd ~/freetz-ng
  tools/prerequisites install # -y

Build firmware:

  cd ~/freetz-ng
  make menuconfig
  make
  # make help

Flash firmware:

  cd ~/freetz-ng
  tools/push_firmware -h

Show GIT states:

  git status
  git diff --no-prefix # --cached # > file.patch
  git log --graph # --oneline

Delete local changes:

  git checkout master ; git fetch --all --prune ; git reset --hard origin/HEAD ; git clean -fd

Update GIT:

  git pull

Checkout old revision:

  git checkout HASH-OF-COMMIT # -b NEW-BRANCH

Checkout another branch:

  git checkout EXISTING-BRANCH

Mirrors:

  git clone https://gitlab.com/Freetz-NG/freetz-ng ~/freetz-ng
  git clone https://bitbucket.org/Freetz-NG/freetz-ng ~/freetz-ng

Documentation:

See https://freetz-ng.github.io/ (or docs/).

Testing your Documentation changes localy

When working on this repo, it is advised that you review your changes locally before committing them. The mkdocs serve command can be used to live preview your changes (as you type) on your local machine.

Please make sure you fork the repo and change the clone URL in the example below for your fork:

  • Linux Mint / Ubuntu 20.04 LTS / 23.10 and later:

    • Preparations (only required once):
    git clone https://github.com/YOUR-USERNAME/freetz-ng
    cd freetz-ng
    sudo apt install python3-pip python3-venv
    python3 -m venv .venv
    source .venv/bin/activate
    pip3 install -r .github/mkdocs/requirements.txt
    • Enter the virtual environment (if exited):
    source .venv/bin/activate
    • Running the docs server:
    mkdocs serve --dev-addr 0.0.0.0:8000
  • Fedora Linux instructions (tested on Fedora Linux 28):

    • Preparations (only required once):
    git clone https://github.com/YOUR-USERNAME/freetz-ng
    cd freetz-ng
    pip install --user -r .github/mkdocs/requirements.txt
    • Running the docs server:
    mkdocs serve --dev-addr 0.0.0.0:8000

After these commands, the current branch is accessible through your favorite browser at http://localhost:8000

About

Freetz-NG firmware modification for ​AVM devices like FRITZ!Box

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Languages

  • Shell 60.2%
  • Makefile 33.9%
  • C 3.8%
  • Perl 1.1%
  • CSS 0.6%
  • Python 0.2%
  • Other 0.2%