aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorXe Iaso <me@xeiaso.net>2025-04-02 23:01:44 -0400
committerGitHub <noreply@github.com>2025-04-02 23:01:44 -0400
commitcaa0befcf880c34fb599a9d22dac27a1299cd543 (patch)
treed1779bfab2a0f690fce1fa8a160f0c00b7775ae7 /docs
parentc76a06e7235c6ac86076b1e7fde18729eb9cfe29 (diff)
parent21a9d77788653f30fef4f3b37e8163a833f1a5d9 (diff)
downloadanubis-Xe/new-anubis.tar.xz
anubis-Xe/new-anubis.zip
Merge branch 'main' into Xe/new-anubisXe/new-anubis
Signed-off-by: Xe Iaso <me@xeiaso.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/CHANGELOG.md2
-rw-r--r--docs/docs/developer/building-anubis.md11
2 files changed, 9 insertions, 4 deletions
diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md
index 48b3c74..2527946 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]
- 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.
- Added a no-store Cache-Control header to the challenge page
- Hide the directory listings for Anubis' internal static content
@@ -31,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Disabled running integration tests on Windows hosts due to it's reliance on posix features (see [#133](https://github.com/TecharoHQ/anubis/pull/133#issuecomment-2764732309)).
- Added support for passing the ed25519 signing key in a file with `-ed25519-private-key-hex-file` or `ED25519_PRIVATE_KEY_HEX_FILE`.
- Fixed minor typos
+- Added a Makefile to enable comfortable workflows for downstream packagers.
- Added `zizmor` for GitHub Actions static analysis
- Fixed most `zizmor` findings
- Enabled Dependabot
diff --git a/docs/docs/developer/building-anubis.md b/docs/docs/developer/building-anubis.md
index a55b8e7..69b2404 100644
--- a/docs/docs/developer/building-anubis.md
+++ b/docs/docs/developer/building-anubis.md
@@ -22,20 +22,23 @@ In order to build a production-ready binary of Anubis, you need the following pa
## Install dependencies
```text
-go mod download
-npm ci
+make deps
```
+This will download Go and NPM dependencies.
+
## Building static assets
```text
-npm run assets
+make assets
```
+This will build all static assets (CSS, JavaScript) for distribution.
+
## Building Anubis to the `./var` folder
```text
-go build -o ./var/anubis ./cmd/anubis
+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.