From 1755dcd526a1ed3c722c4c3b553e1ce18b2df94a Mon Sep 17 00:00:00 2001 From: Amolith Date: Thu, 26 Oct 2023 15:15:40 -0400 Subject: [PATCH] update docs --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 82abe42..6aa093b 100644 --- a/README.md +++ b/README.md @@ -42,19 +42,21 @@ where. I've recorded some of my other ideas and plans in [my wiki]. ## Installation and use * Clone the repo -* Build the binary with `CGO_ENABLED=0 go build .` +* Build the binary with `CGO_ENABLED=0 go build -ldflags="-s -w" -o willow ./cmd` * Upload it to a remote server * Execute the binary -* Reverse proxy `localhost:1337` +* Edit the `config.toml` +* Create a user with `./willow -a ` +* Execute the binary again +* Reverse proxy `http://localhost:1313` * Open the web UI * Click `Track new project` * Fill out the form * Indicate which version you're currently on * That's it! -Note that there's currently no authentication, so consider putting your instance -behind HTTP Basic Auth, keeping it private, or helping me implement -authentication. +Note that I still consider the project to be in _alpha_ state. There will be +bugs; please help fix them! ## Contributing