Deploying

As well as our free hosted version, at networkingtoolbox.net, we've made it as quick and easy as possible for you to deploy your own instance. Either on your own infrastructure, or using one of our supported free hosting providers.

Option #1 - Docker

With Docker installed, just run the following command:

docker run -p 8080:8080 lissy93/networking-toolbox

You can also checkout our docker-compose.yml, using the lissy93/networking-toolbox image from DockerHub.

Option #2 - Free Hosting Provider

You can quickly and easily deploy your own instance for free, on any other our supported hosting providers! Just fork our repository, and then import it into your chosen provider.

Alternatively, just click one of the buttons below!

Option #3 - GitHub Pages

  1. Fork the repository (you'll need a free GitHub account)
  2. Go to your new repo's Settings → Pages → Source and select the gh-pages branch
  3. Then, head to the Actions tab, find the "Deploy to GitHub Pages" workflow, and trigger it
  4. Visit https://[your-username].github.io/networking-toolbox/ to see your deployed app

Option #4 - Source

If you want to make any changes before deploying, or want to host it on any other platform not already covered above, then you can easily do so, by compiling the app from source. It's very easy, and we've dot detailed Building Instructions, or you can check out the docs in the repo.

Customizing

You can customize the branding of your instance, by setting a few environment variables. All are optional.

  • NTB_SITE_NAME - Change sitename
  • NTB_SITE_DESCRIPTION - Change site tagline
  • NTB_SITE_ICON - Set site icon
  • NTB_HOMEPAGE_LAYOUT - Set homepage layout
  • NTB_NAVBAR_DISPLAY - Set navbar display option
  • NTB_DEFAULT_THEME - Set default theme
  • NTB_DEFAULT_LANGUAGE - Set default lang

For examples on how to apply these, take a look at these docs.

Terms

Your only obligations are:

  • Preserve the MIT license. You can view this on the Licensing Page
  • You can not hold the author liable for any damages, and you understand that the software is provided "as is" with no warranties
  • Not use the name "Networking Toolbox" or the logo commercially to build a competing product, without prior permission (you can rebrand it though)
  • Not use the software for anything illegal, harmful, offensive, or otherwise objectionable

Beyond that, you're free to use it however you want, for personal or commercial use. You can rebrand it, or use parts of the code in your own projects and edit anything.