diff options
| author | Xe Iaso <me@xeiaso.net> | 2025-04-06 08:41:47 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-04-06 08:41:47 -0400 |
| commit | ab52d902d5b04d90fe61ca8cb3d43eebce7260b5 (patch) | |
| tree | a470b34d27e1e0d1eb16d2e8ffac4373b2cdd764 /docs | |
| parent | 3661392216783dbb0c186a2cc94c7ad7801bb099 (diff) | |
| parent | f1f8fdf7529daccad8fffe97ca6c868f7a9472c7 (diff) | |
| download | anubis-Xe/pre-npm-tarball.tar.xz anubis-Xe/pre-npm-tarball.zip | |
Merge branch 'main' into Xe/pre-npm-tarballXe/pre-npm-tarball
Signed-off-by: Xe Iaso <me@xeiaso.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/CHANGELOG.md | 1 | ||||
| -rw-r--r-- | docs/docs/developer/building-anubis.md | 17 |
2 files changed, 16 insertions, 2 deletions
diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md index d599a13..0937cc3 100644 --- a/docs/docs/CHANGELOG.md +++ b/docs/docs/CHANGELOG.md @@ -39,6 +39,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fixed most `zizmor` findings - Enabled Dependabot - Added an `--extract-resources` flag to extract static resources to a local folder. +- Add noindex flag to all Anubis pages ([#227](https://github.com/TecharoHQ/anubis/issues/227)). ## v1.15.1 diff --git a/docs/docs/developer/building-anubis.md b/docs/docs/developer/building-anubis.md index f97301f..c826cf6 100644 --- a/docs/docs/developer/building-anubis.md +++ b/docs/docs/developer/building-anubis.md @@ -4,7 +4,7 @@ title: Building Anubis without Docker :::note -These instructions may work, but for right now they are informative for downstream packagers more than they are ready-made instructions for administrators wanting to run Anubis on their servers. +These instructions may work, but for right now they are informative for downstream packagers more than they are ready-made instructions for administrators wanting to run Anubis on their servers. Pre-made binary package support is being tracked in [#156](https://github.com/TecharoHQ/anubis/issues/156). ::: @@ -16,13 +16,20 @@ If you are doing a build entirely from source, here's what you need to do: In order to build a production-ready binary of Anubis, you need the following packages in your environment: -- [Go](https://go.dev) - the programming language that Anubis is written in +- [Go](https://go.dev) at least version 1.24 - the programming language that Anubis is written in - [esbuild](https://esbuild.github.io/) - the JavaScript bundler Anubis uses for its production JS assets - [Node.JS & NPM](https://nodejs.org/en) - manages some build dependencies - `gzip` - compresses production JS (part of coreutils) - `zstd` - compresses production JS - `brotli` - compresses production JS +To upgrade your version of Go without system package manager support, install `golang.org/dl/go1.24.2` (this can be done from any version of Go): + +```text +go install golang.org/dl/go1.24.2@latest +go1.24.2 download +``` + ### Install dependencies ```text @@ -63,3 +70,9 @@ make prebaked-build ``` Anubis will be built to `./var/anubis`. + +## Development dependencies + +Optionally, you can install the following dependencies for development: + +- [Staticcheck](https://staticcheck.dev/docs/getting-started/) (optional, not required due to [`go tool staticcheck`](https://www.alexedwards.net/blog/how-to-manage-tool-dependencies-in-go-1.24-plus), but required if you are using any version of Go older than 1.24) |