@@ -74,41 +74,40 @@ in [his wiki].
## Installation and use
**Disclaimers:**
-1. Prebuilt binaries will be available with the [v0.0.1] release, greatly- simplifying installation.-2. We consider the project _alpha-quality_. There will be bugs.-3. Amolith has tried to make the web UI accessible, but is unsure of its current- usability.-4. The app is not localised yet and English is the only available language.-5. Help with any/all of the above is most welcome!--[v0.0.1]: https://todo.sr.ht/~amolith/willow?search=status%3Aopen%20label%3A%22v0.0.1%22-[communication platforms]: #contributing
+- Docker image coming soon™
+- We consider the project _alpha-quality_. There will be bugs.
+- Amolith has tried to make the web UI accessible, but is unsure of its current
+ usability.
+- The app is not localised yet and English is the only available language.
+- Help with any/all of the above is most welcome!
### Installation
This assumes Willow will run on an always-on server, like a VPS.
-* Clone the repo with `git clone https://git.sr.ht/~amolith/willow`-* Enter the repo's folder with `cd willow`-* Build the binary with `CGO_ENABLED=0 go build -ldflags="-s -w" -o willow- ./cmd`-* Transfer the binary to the server however you like-* Execute the binary with `./willow`-* Edit the config with `vim config.toml`-* Daemonise Willow using systemd or OpenRC or whatever you prefer-* Reverse-proxy the web UI (defaults to `localhost:1313`) with Caddy or NGINX or- whatever you prefer
+- Obtain the binary appropriate for your system from one of the release pages
+ (they're all the same)
+ - [SourceHut](https://git.sr.ht/~amolith/willow/refs)
+ - [Codeberg](https://codeberg.org/Amolith/willow/releases)
+ - [GitHub](https://github.com/Amolith/willow/releases)
+- Make sure you're in the same folder as the binary when running the following
+ commands
+- Mark the binary as executable with `chmod +x willow`
+- Execute the binary with `./willow`
+- Edit the config with `nano config.toml`
+- Daemonise Willow using systemd, OpenRC, etc.
+- Reverse-proxy the web UI (defaults to `localhost:1313`) with Caddy, NGINX,
+ etc.
### Use
-* Create a user with `./willow -a <username>`-* Open the web UI (defaults to `localhost:1313`, but [installation] had you put
+- Create a user with `./willow -a <username>`
+- Open the web UI (defaults to `localhost:1313`, but [installation] had you put
a proxy in front)
-* Click `Track new project`-* Fill out the form and press `Next`-* Indicate which version you're currently on and press `Track releases`-* You're now tracking that project's releases!
+- Click `Track new project`
+- Fill out the form and press `Next`
+- Indicate which version you're currently on and press `Track releases`
+- You're now tracking that project's releases!
[installation]: #installation