nuke/docs
Henri Vasserman 57c3e9f1b2
Change how to make Anubis work without a reverse proxy (#86)
* Change how to make Anubis work without a reverse proxy

* Apply suggestions from code review

Co-authored-by: Xe Iaso <me@xeiaso.net>
Signed-off-by: Henri Vasserman <henv@hot.ee>

* add support for unix sockets.

* add env var docs

* lib: fix tests

Signed-off-by: Xe Iaso <me@xeiaso.net>

---------

Signed-off-by: Henri Vasserman <henv@hot.ee>
Signed-off-by: Xe Iaso <me@xeiaso.net>
Co-authored-by: Xe Iaso <me@xeiaso.net>
2025-03-28 13:38:34 -04:00
..
blog add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
docs Change how to make Anubis work without a reverse proxy (#86) 2025-03-28 13:38:34 -04:00
manifest cmd/anubis: allow setting key bytes in flag/envvar (#97) 2025-03-25 17:02:48 -04:00
src fix(docs): Make dark mode diff lines readable (#130) 2025-03-26 15:44:20 -04:00
static Fix: Removed several visible AI artifacts (e.g., 6 fingers) (#37) 2025-03-20 16:09:49 -04:00
.dockerignore add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
.gitignore add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
Dockerfile Explicitely define image sources in Dockerfile (#21) 2025-03-20 17:28:30 -04:00
docusaurus.config.ts docs: add funding page 2025-03-20 15:36:34 -04:00
package-lock.json add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
package.json add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
README.md add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
sidebars.ts add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
tsconfig.json add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00

Website

This website is built using Docusaurus, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.