Skip to content

Commit e488ee9

Browse files
MickLeskMickLesk
authored
Merge pull request #2302 from opastorello/add-anubis
feat: add Anubis LXC script
2 parents 81f7fcd + 8445254 commit e488ee9

3 files changed

Lines changed: 157 additions & 0 deletions

File tree

‎ct/anubis.sh‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
#!/usr/bin/env bash
2+
_cs_boot="${COMMUNITY_SCRIPTS_CORE_DIR:-$(dirname "${BASH_SOURCE[0]}")/../../core}/core/build.func"
3+
source "$_cs_boot" 2>/dev/null || source <(curl -fsSL "${COMMUNITY_SCRIPTS_CORE_URL:-https://raw.githubusercontent.com/community-scripts/core/main}/core/build.func")
4+
5+
# Copyright (c) 2021-2026 community-scripts ORG
6+
# Author: Nicolas Pastorello (opastorello)
7+
# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
8+
# Source: https://anubis.techaro.lol/
9+
10+
APP="Anubis"
11+
var_tags="${var_tags:-proxy;security}"
12+
var_cpu="${var_cpu:-1}"
13+
var_ram="${var_ram:-512}"
14+
var_disk="${var_disk:-4}"
15+
var_os="${var_os:-debian}"
16+
var_version="${var_version:-13}"
17+
var_unprivileged="${var_unprivileged:-1}"
18+
#var_arm64="${var_arm64:-no}" # unset = ask the user; set yes/no only when verified
19+
20+
export var_anubis_target="${var_anubis_target:-}"
21+
22+
header_info "$APP"
23+
variables
24+
color
25+
catch_errors
26+
27+
function update_script() {
28+
header_info
29+
check_container_storage
30+
check_container_resources
31+
32+
if [[ ! -f /etc/anubis/main.env ]]; then
33+
msg_error "No ${APP} Installation Found!"
34+
exit
35+
fi
36+
37+
if check_for_gh_release "anubis" "TecharoHQ/anubis"; then
38+
msg_info "Stopping Service"
39+
systemctl stop anubis@main
40+
msg_ok "Stopped Service"
41+
42+
fetch_and_deploy_gh_release "anubis" "TecharoHQ/anubis" "binary"
43+
44+
msg_info "Starting Service"
45+
systemctl start anubis@main
46+
msg_ok "Started Service"
47+
msg_ok "Updated successfully!"
48+
fi
49+
exit
50+
}
51+
52+
start
53+
build_container
54+
description
55+
56+
msg_ok "Completed Successfully!\n"
57+
echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
58+
echo -e "${INFO}${YW}Access it using the following URL:${CL}"
59+
echo -e "${GATEWAY}${BGN}http://${IP}:8923${CL}"

‎install/anubis-install.sh‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#!/usr/bin/env bash
2+
3+
# Copyright (c) 2021-2026 community-scripts ORG
4+
# Author: Nicolas Pastorello (opastorello)
5+
# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
6+
# Source: https://anubis.techaro.lol/
7+
8+
source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
9+
color
10+
verb_ip6
11+
catch_errors
12+
setting_up_container
13+
network_check
14+
update_os
15+
16+
fetch_and_deploy_gh_release "anubis" "TecharoHQ/anubis" "binary"
17+
18+
msg_info "Configuring Anubis"
19+
cp /usr/share/doc/anubis/botPolicies.yaml /etc/anubis/main.botPolicies.yaml
20+
cat <<EOF >/etc/anubis/main.env
21+
BIND=:8923
22+
BIND_NETWORK=tcp
23+
METRICS_BIND=:9090
24+
METRICS_BIND_NETWORK=tcp
25+
DIFFICULTY=4
26+
SERVE_ROBOTS_TXT=0
27+
COOKIE_SECURE=false
28+
USE_REMOTE_ADDRESS=true
29+
POLICY_FNAME=/etc/anubis/main.botPolicies.yaml
30+
ED25519_PRIVATE_KEY_HEX=$(openssl rand -hex 32)
31+
TARGET=${var_anubis_target:-http://localhost:3000}
32+
EOF
33+
systemctl enable -q --now anubis@main
34+
msg_ok "Configured Anubis"
35+
36+
motd_ssh
37+
customize
38+
cleanup_lxc

‎json/anubis.json‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
{
2+
"name": "Anubis",
3+
"slug": "anubis",
4+
"categories": [21, 6],
5+
"date_created": "2026-09-18",
6+
"type": "ct",
7+
"updateable": true,
8+
"privileged": false,
9+
"interface_port": 8923,
10+
"documentation": "https://anubis.techaro.lol/docs/",
11+
"website": "https://anubis.techaro.lol/",
12+
"repository": "https://github.com/TecharoHQ/anubis",
13+
"logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/anubis.webp",
14+
"description": "Anubis is a reverse proxy that sits in front of a web service and stops AI scrapers and abusive bots with a proof-of-work challenge, while letting real browsers and well-behaved crawlers through.",
15+
"install_methods": [
16+
{
17+
"type": "default",
18+
"script": "ct/anubis.sh",
19+
"config_path": "/etc/anubis/main.env",
20+
"resources": {
21+
"cpu": 1,
22+
"ram": 512,
23+
"hdd": 4,
24+
"os": "Debian",
25+
"version": "13"
26+
}
27+
}
28+
],
29+
"default_credentials": {
30+
"username": null,
31+
"password": null
32+
},
33+
"app_vars": [
34+
{
35+
"name": "var_anubis_target",
36+
"label": "Upstream URL to protect",
37+
"type": "text",
38+
"default": "http://localhost:3000",
39+
"help": "The service Anubis proxies to, e.g. http://192.168.1.50:3000. Can be changed later in /etc/anubis/main.env"
40+
}
41+
],
42+
"notes": [
43+
{
44+
"text": "Set TARGET in /etc/anubis/main.env to the service you want to protect, then run `systemctl restart anubis@main`. Point your reverse proxy or DNS at this container on port 8923.",
45+
"type": "warning"
46+
},
47+
{
48+
"text": "The container is configured for direct exposure over plain HTTP (COOKIE_SECURE=false, USE_REMOTE_ADDRESS=true). When you put a TLS reverse proxy in front of it, set COOKIE_SECURE=true and remove USE_REMOTE_ADDRESS so client IPs come from X-Forwarded-For.",
49+
"type": "info"
50+
},
51+
{
52+
"text": "One Anubis instance protects one TARGET. For another service, copy /etc/anubis/main.env to /etc/anubis/<name>.env with its own BIND, METRICS_BIND and TARGET and run `systemctl enable --now anubis@<name>`. Alternatively point TARGET at a reverse proxy that routes by Host header and a single instance covers all its sites.",
53+
"type": "info"
54+
},
55+
{
56+
"text": "Bot policies live in /etc/anubis/main.botPolicies.yaml (a copy of the upstream default). Prometheus metrics are exposed on port 9090.",
57+
"type": "info"
58+
}
59+
]
60+
}

0 commit comments

Comments
 (0)