Skip to content

Commit 08d52c5

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 978eea8 commit 08d52c5

File tree

1 file changed

+85
-46
lines changed

1 file changed

+85
-46
lines changed

‎readme-vars.yml‎

Lines changed: 85 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -7,69 +7,108 @@ project_logo: "https://raw.githubusercontent.com/netbox-community/netbox/develop
77
project_blurb: |
88
[{{ project_name|capitalize }}]({{ project_url }}) is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations.
99
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
10-
1110
# supported architectures
1211
available_architectures:
13-
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
14-
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
15-
12+
- {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
13+
- {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
1614
# container parameters
1715
param_container_name: "{{ project_name }}"
1816
param_usage_include_vols: true
1917
param_volumes:
20-
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files" }
18+
- {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"}
2119
param_usage_include_env: true
2220
param_env_vars:
23-
- { env_var: "SUPERUSER_EMAIL", env_value: "", desc: "Email address for `admin` account" }
24-
- { env_var: "SUPERUSER_PASSWORD", env_value: "", desc: "Password for `admin` account" }
25-
- { env_var: "ALLOWED_HOST", env_value: "", desc: "The hostname you will use to access the app (i.e., netbox.example.com)" }
26-
- { env_var: "DB_NAME", env_value: "", desc: "Database name (default: netbox)" }
27-
- { env_var: "DB_USER", env_value: "", desc: "Database user" }
28-
- { env_var: "DB_PASSWORD", env_value: "", desc: "Database password" }
29-
- { env_var: "DB_HOST", env_value: "", desc: "Database host (default: postgres)" }
30-
- { env_var: "DB_PORT", env_value: "", desc: "Database port (default: 5432)" }
31-
- { env_var: "REDIS_HOST", env_value: "", desc: "Redis host (default: redis)" }
32-
- { env_var: "REDIS_PORT", env_value: "", desc: "Redis port number (default: 6379)" }
33-
- { env_var: "REDIS_PASSWORD", env_value: "", desc: "Redis password (default: none)" }
34-
- { env_var: "REDIS_DB_TASK", env_value: "", desc: "Redis database ID for tasks (default: 0)" }
35-
- { env_var: "REDIS_DB_CACHE", env_value: "", desc: "Redis database ID for caching (default: 1)" }
36-
21+
- {env_var: "SUPERUSER_EMAIL", env_value: "", desc: "Email address for `admin` account"}
22+
- {env_var: "SUPERUSER_PASSWORD", env_value: "", desc: "Password for `admin` account"}
23+
- {env_var: "ALLOWED_HOST", env_value: "", desc: "The hostname you will use to access the app (i.e., netbox.example.com)"}
24+
- {env_var: "DB_NAME", env_value: "", desc: "Database name (default: netbox)"}
25+
- {env_var: "DB_USER", env_value: "", desc: "Database user"}
26+
- {env_var: "DB_PASSWORD", env_value: "", desc: "Database password"}
27+
- {env_var: "DB_HOST", env_value: "", desc: "Database host (default: postgres)"}
28+
- {env_var: "DB_PORT", env_value: "", desc: "Database port (default: 5432)"}
29+
- {env_var: "REDIS_HOST", env_value: "", desc: "Redis host (default: redis)"}
30+
- {env_var: "REDIS_PORT", env_value: "", desc: "Redis port number (default: 6379)"}
31+
- {env_var: "REDIS_PASSWORD", env_value: "", desc: "Redis password (default: none)"}
32+
- {env_var: "REDIS_DB_TASK", env_value: "", desc: "Redis database ID for tasks (default: 0)"}
33+
- {env_var: "REDIS_DB_CACHE", env_value: "", desc: "Redis database ID for caching (default: 1)"}
3734
opt_param_usage_include_env: true
3835
opt_param_env_vars:
39-
- { env_var: "BASE_PATH", env_value: "", desc: "The path you will use to access the app (i.e., /netbox, optional, default: none)" }
40-
- { env_var: "REMOTE_AUTH_ENABLED", env_value: "", desc: "Enable remote authentication (optional, default: False)" }
41-
- { env_var: "REMOTE_AUTH_BACKEND", env_value: "", desc: "Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend)" }
42-
- { env_var: "REMOTE_AUTH_HEADER", env_value: "", desc: "Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER)" }
43-
- { env_var: "REMOTE_AUTH_AUTO_CREATE_USER", env_value: "", desc: "If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False)" }
44-
- { env_var: "REMOTE_AUTH_DEFAULT_GROUPS", env_value: "", desc: "The list of groups to assign a new user account when created using remote authentication (optional, default: [])" }
45-
- { env_var: "REMOTE_AUTH_DEFAULT_PERMISSIONS", env_value: "", desc: "A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {})" }
46-
36+
- {env_var: "BASE_PATH", env_value: "", desc: "The path you will use to access the app (i.e., /netbox, optional, default: none)"}
37+
- {env_var: "REMOTE_AUTH_ENABLED", env_value: "", desc: "Enable remote authentication (optional, default: False)"}
38+
- {env_var: "REMOTE_AUTH_BACKEND", env_value: "", desc: "Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend)"}
39+
- {env_var: "REMOTE_AUTH_HEADER", env_value: "", desc: "Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER)"}
40+
- {env_var: "REMOTE_AUTH_AUTO_CREATE_USER", env_value: "", desc: "If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False)"}
41+
- {env_var: "REMOTE_AUTH_DEFAULT_GROUPS", env_value: "", desc: "The list of groups to assign a new user account when created using remote authentication (optional, default: [])"}
42+
- {env_var: "REMOTE_AUTH_DEFAULT_PERMISSIONS", env_value: "", desc: "A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {})"}
4743
param_usage_include_ports: true
4844
param_ports:
49-
- { external_port: "8000", internal_port: "8000", port_desc: "will map the container's port 8000 to port 8000 on the host" }
50-
45+
- {external_port: "8000", internal_port: "8000", port_desc: "will map the container's port 8000 to port 8000 on the host"}
5146
# application setup block
5247
app_setup_block_enabled: true
5348
app_setup_block: |
5449
Netbox requires a postgres database and a redis instance.
5550
5651
Access the WebUI at <your-ip>:8000. For more information, check out [NetBox](https://github.com/netbox-community/netbox).
57-
52+
# init diagram
53+
init_diagram: |
54+
"netbox:latest": {
55+
docker-mods
56+
base {
57+
fix-attr +\nlegacy cont-init
58+
}
59+
docker-mods -> base
60+
legacy-services
61+
custom services
62+
init-services -> legacy-services
63+
init-services -> custom services
64+
custom services -> legacy-services
65+
legacy-services -> ci-service-check
66+
init-migrations -> init-adduser
67+
init-os-end -> init-config
68+
init-config -> init-config-end
69+
init-netbox-config -> init-config-end
70+
init-os-end -> init-crontab-config
71+
init-mods-end -> init-custom-files
72+
base -> init-envfile
73+
base -> init-migrations
74+
base -> init-mods
75+
init-config-end -> init-mods
76+
init-mods -> init-mods-end
77+
init-mods-package-install -> init-mods-end
78+
init-mods -> init-mods-package-install
79+
init-config -> init-netbox-config
80+
base -> init-os-end
81+
init-adduser -> init-os-end
82+
init-envfile -> init-os-end
83+
init-migrations -> init-os-end
84+
init-custom-files -> init-services
85+
init-mods-end -> init-services
86+
init-services -> svc-cron
87+
svc-cron -> legacy-services
88+
svc-netbox-prepare -> svc-netbox
89+
svc-netbox -> legacy-services
90+
init-services -> svc-netbox-prepare
91+
svc-netbox-prepare -> legacy-services
92+
}
93+
Base Images: {
94+
"baseimage-alpine:3.20"
95+
}
96+
"netbox:latest" <- Base Images
5897
# changelog
5998
changelogs:
60-
- { date: "26.08.24:", desc: "Restructure init to allow for plugins as mods."}
61-
- { date: "16.07.24:", desc: "Add required packages for LDAP support."}
62-
- { date: "01.06.24:", desc: "Rebase to Alpine 3.20."}
63-
- { date: "23.12.23:", desc: "Rebase to Alpine 3.19."}
64-
- { date: "11.06.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." }
65-
- { date: "14.05.23:", desc: "Build local docs on first run." }
66-
- { date: "05.03.23:", desc: "Rebase to Alpine 3.17." }
67-
- { date: "02.11.22:", desc: "Rebase to Alpine 3.16, migrate to s6v3." }
68-
- { date: "01.08.22:", desc: "Remove py3-pillow, add tiff to fix deps." }
69-
- { date: "26.07.22:", desc: "Add py3-pillow package back on arm to fix build issue." }
70-
- { date: "10.12.21:", desc: "Remove py3-pillow package to fix dependency issue with 3.2.0." }
71-
- { date: "10.12.21:", desc: "Rebase to Alpine 3.15." }
72-
- { date: "26.04.21:", desc: "Added Redis database environment variables." }
73-
- { date: "03.02.21:", desc: "Added remote authentication environment variables." }
74-
- { date: "02.01.21:", desc: "Added BASE_PATH environment variable." }
75-
- { date: "23.08.20:", desc: "Initial Release." }
99+
- {date: "26.08.24:", desc: "Restructure init to allow for plugins as mods."}
100+
- {date: "16.07.24:", desc: "Add required packages for LDAP support."}
101+
- {date: "01.06.24:", desc: "Rebase to Alpine 3.20."}
102+
- {date: "23.12.23:", desc: "Rebase to Alpine 3.19."}
103+
- {date: "11.06.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."}
104+
- {date: "14.05.23:", desc: "Build local docs on first run."}
105+
- {date: "05.03.23:", desc: "Rebase to Alpine 3.17."}
106+
- {date: "02.11.22:", desc: "Rebase to Alpine 3.16, migrate to s6v3."}
107+
- {date: "01.08.22:", desc: "Remove py3-pillow, add tiff to fix deps."}
108+
- {date: "26.07.22:", desc: "Add py3-pillow package back on arm to fix build issue."}
109+
- {date: "10.12.21:", desc: "Remove py3-pillow package to fix dependency issue with 3.2.0."}
110+
- {date: "10.12.21:", desc: "Rebase to Alpine 3.15."}
111+
- {date: "26.04.21:", desc: "Added Redis database environment variables."}
112+
- {date: "03.02.21:", desc: "Added remote authentication environment variables."}
113+
- {date: "02.01.21:", desc: "Added BASE_PATH environment variable."}
114+
- {date: "23.08.20:", desc: "Initial Release."}

0 commit comments

Comments
 (0)