Skip to content

Commit 85e3b1a

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent a96801f commit 85e3b1a

File tree

1 file changed

+105
-53
lines changed

1 file changed

+105
-53
lines changed

‎readme-vars.yml

Lines changed: 105 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -11,39 +11,33 @@ project_blurb: |
1111
Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
1212
1313
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
14-
1514
# supported architectures
1615
available_architectures:
17-
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
18-
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
19-
16+
- {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
17+
- {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
2018
# container parameters
2119
param_container_name: "{{ project_name }}"
2220
param_usage_include_vols: true
2321
param_volumes:
24-
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files" }
22+
- {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"}
2523
param_usage_include_env: true
2624
param_env_vars:
27-
- { env_var: "APP_URL", env_value: "", desc: "The protocol, IP/URL, and port that your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"}
28-
- { env_var: "APP_KEY", env_value: "", desc: "Session encryption key. You will need to generate this with `docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey`"}
29-
- { env_var: "DB_HOST", env_value: "", desc: "The database instance hostname" }
30-
- { env_var: "DB_PORT", env_value: "3306", desc: "Database port" }
31-
- { env_var: "DB_USERNAME", env_value: "", desc: "Database user" }
32-
- { env_var: "DB_PASSWORD", env_value: "", desc: "Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)" }
33-
- { env_var: "DB_DATABASE", env_value: "", desc: "Database name" }
34-
25+
- {env_var: "APP_URL", env_value: "", desc: "The protocol, IP/URL, and port that your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"}
26+
- {env_var: "APP_KEY", env_value: "", desc: "Session encryption key. You will need to generate this with `docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey`"}
27+
- {env_var: "DB_HOST", env_value: "", desc: "The database instance hostname"}
28+
- {env_var: "DB_PORT", env_value: "3306", desc: "Database port"}
29+
- {env_var: "DB_USERNAME", env_value: "", desc: "Database user"}
30+
- {env_var: "DB_PASSWORD", env_value: "", desc: "Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)"}
31+
- {env_var: "DB_DATABASE", env_value: "", desc: "Database name"}
3532
param_usage_include_ports: true
3633
param_ports:
37-
- { external_port: "6875", internal_port: "80", port_desc: "http/s web interface." }
38-
34+
- {external_port: "6875", internal_port: "80", port_desc: "http/s web interface."}
3935
opt_param_usage_include_env: true
4036
opt_param_env_vars:
41-
- { env_var: "QUEUE_CONNECTION", env_value: "", desc: "Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling)." }
42-
37+
- {env_var: "QUEUE_CONNECTION", env_value: "", desc: "Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling)."}
4338
# application setup block
4439
app_setup_block_enabled: true
45-
app_setup_block: |
46-
40+
app_setup_block: |2
4741
The default username is admin@admin.com with the password of **password**, access the container at http://<host ip>:6875.
4842
4943
This application is dependent on a MariaDB database, be it one you already have or a new one. If you do not already have one, we provide an image here https://github.com/linuxserver/docker-mariadb.
@@ -80,39 +74,97 @@ app_setup_block: |
8074
If you wish to use the extra functionality of BookStack such as email, LDAP and so on you will need to set additional environment variables or make your own .env file with guidance from the BookStack documentation.
8175
8276
The container will copy an exemplary .env file to /config/www/.env on your host system for you to use.
83-
77+
# init diagram
78+
init_diagram: |
79+
"bookstack:latest": {
80+
docker-mods
81+
base {
82+
fix-attr +\nlegacy cont-init
83+
}
84+
docker-mods -> base
85+
legacy-services
86+
custom services
87+
init-services -> legacy-services
88+
init-services -> custom services
89+
custom services -> legacy-services
90+
legacy-services -> ci-service-check
91+
init-migrations -> init-adduser
92+
init-nginx-end -> init-bookstack-config
93+
init-nginx-end -> init-config
94+
init-os-end -> init-config
95+
init-bookstack-config -> init-config-end
96+
init-config -> init-config-end
97+
init-os-end -> init-crontab-config
98+
init-mods-end -> init-custom-files
99+
base -> init-envfile
100+
init-os-end -> init-folders
101+
init-php -> init-keygen
102+
base -> init-migrations
103+
base -> init-mods
104+
init-config-end -> init-mods
105+
init-version-checks -> init-mods
106+
init-mods -> init-mods-end
107+
init-mods-package-install -> init-mods-end
108+
init-mods -> init-mods-package-install
109+
init-samples -> init-nginx
110+
init-permissions -> init-nginx-end
111+
base -> init-os-end
112+
init-adduser -> init-os-end
113+
init-envfile -> init-os-end
114+
init-migrations -> init-os-end
115+
init-keygen -> init-permissions
116+
init-nginx -> init-php
117+
init-folders -> init-samples
118+
init-custom-files -> init-services
119+
init-mods-end -> init-services
120+
init-config-end -> init-version-checks
121+
init-services -> svc-cron
122+
svc-cron -> legacy-services
123+
init-services -> svc-memcached
124+
svc-memcached -> legacy-services
125+
init-services -> svc-nginx
126+
svc-nginx -> legacy-services
127+
init-services -> svc-php-fpm
128+
svc-php-fpm -> legacy-services
129+
init-services -> svc-queue-worker
130+
svc-queue-worker -> legacy-services
131+
}
132+
Base Images: {
133+
"baseimage-alpine-nginx:3.20" <- "baseimage-alpine:3.20"
134+
}
135+
"bookstack:latest" <- Base Images
84136
# changelog
85137
changelogs:
86-
- { date: "11.10.24:", desc: "Default to environment config over .env file config."}
87-
- { date: "06.09.24:", desc: "Add php-exif for reading image EXIF data."}
88-
- { date: "27.05.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}
89-
- { date: "25.01.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf." }
90-
- { date: "23.12.23:", desc: "Rebase to Alpine 3.19 with php 8.3."}
91-
- { date: "31.10.23:", desc: "Further sanitize sed replace." }
92-
- { date: "07.06.23:", desc: "Add mariadb-client for bookstack-system-cli support." }
93-
- { date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." }
94-
- { date: "13.04.23:", desc: "Move ssl.conf include to default.conf." }
95-
- { date: "01.03.23:", desc: "Add php iconv." }
96-
- { date: "19.01.23:", desc: "Rebase to alpine 3.17 with php8.1." }
97-
- { date: "16.01.23:", desc: "Wrap `.env` values in quotes." }
98-
- { date: "05.01.23:", desc: "Fix db password setting (sed escape `&`)." }
99-
- { date: "21.12.22:", desc: "Update db info in .env file when env vars are updated." }
100-
- { date: "10.10.22:", desc: "Remove password escape logic which caused problems for a small subset of users." }
101-
- { date: "20.08.22:", desc: "Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))." }
102-
- { date: "14.03.22:", desc: "Add symlinks for theme support." }
103-
- { date: "11.07.21:", desc: "Rebase to Alpine 3.14." }
104-
- { date: "12.01.21:", desc: "Remove unused requirement, as of release 0.31.0." }
105-
- { date: "17.12.20:", desc: "Make APP_URL var required (upstream changes)." }
106-
- { date: "17.09.20:", desc: "Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default." }
107-
- { date: "19.12.19:", desc: "Rebasing to alpine 3.11." }
108-
- { date: "26.07.19:", desc: "Use old version of tidyhtml pending upstream fixes." }
109-
- { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
110-
- { date: "14.06.19:", desc: "Add wkhtmltopdf to image for PDF rendering." }
111-
- { date: "20.04.19:", desc: "Rebase to Alpine 3.9, add MySQL init logic." }
112-
- { date: "22.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
113-
- { date: "20.01.19:", desc: "Added php7-curl"}
114-
- { date: "04.11.18:", desc: "Added php7-ldap"}
115-
- { date: "15.10.18:", desc: "Changed functionality for advanced users"}
116-
- { date: "08.10.18:", desc: "Advanced mode, symlink changes, sed fixing, docs updated, added some composer files"}
117-
- { date: "23.09.28:", desc: "Updates pre-release"}
118-
- { date: "02.07.18:", desc: "Initial Release." }
138+
- {date: "11.10.24:", desc: "Default to environment config over .env file config."}
139+
- {date: "06.09.24:", desc: "Add php-exif for reading image EXIF data."}
140+
- {date: "27.05.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}
141+
- {date: "25.01.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf."}
142+
- {date: "23.12.23:", desc: "Rebase to Alpine 3.19 with php 8.3."}
143+
- {date: "31.10.23:", desc: "Further sanitize sed replace."}
144+
- {date: "07.06.23:", desc: "Add mariadb-client for bookstack-system-cli support."}
145+
- {date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."}
146+
- {date: "13.04.23:", desc: "Move ssl.conf include to default.conf."}
147+
- {date: "01.03.23:", desc: "Add php iconv."}
148+
- {date: "19.01.23:", desc: "Rebase to alpine 3.17 with php8.1."}
149+
- {date: "16.01.23:", desc: "Wrap `.env` values in quotes."}
150+
- {date: "05.01.23:", desc: "Fix db password setting (sed escape `&`)."}
151+
- {date: "21.12.22:", desc: "Update db info in .env file when env vars are updated."}
152+
- {date: "10.10.22:", desc: "Remove password escape logic which caused problems for a small subset of users."}
153+
- {date: "20.08.22:", desc: "Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))."}
154+
- {date: "14.03.22:", desc: "Add symlinks for theme support."}
155+
- {date: "11.07.21:", desc: "Rebase to Alpine 3.14."}
156+
- {date: "12.01.21:", desc: "Remove unused requirement, as of release 0.31.0."}
157+
- {date: "17.12.20:", desc: "Make APP_URL var required (upstream changes)."}
158+
- {date: "17.09.20:", desc: "Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default."}
159+
- {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
160+
- {date: "26.07.19:", desc: "Use old version of tidyhtml pending upstream fixes."}
161+
- {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
162+
- {date: "14.06.19:", desc: "Add wkhtmltopdf to image for PDF rendering."}
163+
- {date: "20.04.19:", desc: "Rebase to Alpine 3.9, add MySQL init logic."}
164+
- {date: "22.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
165+
- {date: "20.01.19:", desc: "Added php7-curl"}
166+
- {date: "04.11.18:", desc: "Added php7-ldap"}
167+
- {date: "15.10.18:", desc: "Changed functionality for advanced users"}
168+
- {date: "08.10.18:", desc: "Advanced mode, symlink changes, sed fixing, docs updated, added some composer files"}
169+
- {date: "23.09.28:", desc: "Updates pre-release"}
170+
- {date: "02.07.18:", desc: "Initial Release."}

0 commit comments

Comments
 (0)