alice.The music bot
field guide
Take the docs anywhere

Small site. Easy move.

This documentation is plain HTML, CSS and JavaScript. Copy the files, point your web server at them, and you’re ready.

The folder you need

The website lives in website/dist/. Only upload that folder to a static web host. All fonts, artwork and search data are included.

Set your public domain

Before uploading, run the generator from the website directory with your final domain. This updates canonical links, structured data, robots.txt and sitemap.xml. The production domain is alicemusic.online.

Terminal
python3 build.py --site-url https://alicemusic.online

Option A · Docker on a VPS

With Docker and Docker Compose installed, copy the entire website folder onto the VPS, open that directory, and run:

Terminal
docker compose up -d --build

The included container serves the website on port 8080. Open http://YOUR_VPS_IP:8080 to check it. Point an HTTPS reverse proxy such as Caddy or Nginx at port 8080 when connecting your domain. Allow the chosen port in your firewall if you need direct remote access.

Option B · Nginx static hosting

Copy the contents of dist/ into a directory such as /var/www/alice-docs. Configure Nginx with your actual domain:

Nginx server block
server {
    listen 80;
    server_name alicemusic.online;
    root /var/www/alice-docs;
    index index.html;

    location / {
        try_files $uri $uri/ =404;
    }
    error_page 404 /404.html;
}

Validate with sudo nginx -t, then reload Nginx. Add an HTTPS certificate using your hosting provider or certificate manager.

Or use a static host

Any host that serves static files can use the contents of dist/. Choose that directory as the publish directory. The runtime needs no package install, build command, secrets or database.

Preview locally

Terminal
python3 -m http.server 4173 --directory dist

Open http://localhost:4173. Use a local HTTP server so the documentation search can load its index.

KEEP GOINGMeet the people behind the project
Search the field guide · ↓ to select · Enter to open · Esc to close