diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/CHANGELOG.md | 1 | ||||
| -rw-r--r-- | docs/docs/developer/building-anubis.md | 23 | ||||
| -rw-r--r-- | docs/docs/developer/local-dev.md | 2 |
3 files changed, 24 insertions, 2 deletions
diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md index d4aac89..0937cc3 100644 --- a/docs/docs/CHANGELOG.md +++ b/docs/docs/CHANGELOG.md @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] - Added support for native Debian, Red Hat, and tarball packaging strategies including installation and use directions. +- A prebaked tarball has been added, allowing distros to build Anubis like they could in v1.15.x. - The placeholder Anubis mascot has been replaced with a design by [CELPHASE](https://bsky.app/profile/celphase.bsky.social). - Allow iMessage's link preview fetcher through Anubis by default. - Added a periodic cleanup routine for the decaymap that removes expired entries, ensuring stale data is properly pruned. diff --git a/docs/docs/developer/building-anubis.md b/docs/docs/developer/building-anubis.md index ebc8e21..c826cf6 100644 --- a/docs/docs/developer/building-anubis.md +++ b/docs/docs/developer/building-anubis.md @@ -8,7 +8,11 @@ These instructions may work, but for right now they are informative for downstre ::: -## Tools needed +## Entirely from source + +If you are doing a build entirely from source, here's what you need to do: + +### Tools needed In order to build a production-ready binary of Anubis, you need the following packages in your environment: @@ -50,6 +54,23 @@ make build From this point it is up to you to make sure that `./var/anubis` ends up in the right place. You may want to consult the `./run` folder for useful files such as a systemd unit and `anubis.env.default` file. +## "Pre-baked" tarball + +The `anubis-src-with-vendor` tarball has many pre-build steps already done, including: + +- Go module dependencies are present in `./vendor` +- Static assets (JS, CSS, etc.) are already built in CI + +This means you do not have to manage Go, NPM, or other ecosystem dependencies. + +When using this tarball, all you need to do is build `./cmd/anubis`: + +```text +make prebaked-build +``` + +Anubis will be built to `./var/anubis`. + ## Development dependencies Optionally, you can install the following dependencies for development: diff --git a/docs/docs/developer/local-dev.md b/docs/docs/developer/local-dev.md index 11a170b..0919d5f 100644 --- a/docs/docs/developer/local-dev.md +++ b/docs/docs/developer/local-dev.md @@ -69,7 +69,7 @@ Install `yeet`: ::: ```text -go install within.website/x/cmd/yeet@v1.13.3 +go install within.website/x/cmd/yeet@v1.13.4 ``` Install the dependencies for Anubis: |