From dfc66873dbd2cd07ab4767d896e3a8e71d4b2429 Mon Sep 17 00:00:00 2001 From: lamusmaser Date: Sat, 20 Apr 2024 05:48:55 -0600 Subject: [PATCH] Additional formatting fixes. Replacing one admonition with footnote. Adding footnotes feature. --- mkdocs/docs/configuration/forward-auth.md | 6 +- mkdocs/docs/installation/podman.md | 8 +- mkdocs/docs/installation/synology.md | 158 +++++++++++----------- mkdocs/mkdocs.yml | 1 + 4 files changed, 87 insertions(+), 86 deletions(-) diff --git a/mkdocs/docs/configuration/forward-auth.md b/mkdocs/docs/configuration/forward-auth.md index 554022b..de4512f 100644 --- a/mkdocs/docs/configuration/forward-auth.md +++ b/mkdocs/docs/configuration/forward-auth.md @@ -9,7 +9,7 @@ Note that this automatically creates new users in the database if they do not al | Environment Variable | Example | Description | | :------------------- | :------ | :---------- | | `TA_ENABLE_AUTH_PROXY` | `true` | Set to anything besides empty string to use forward proxy authentication. | -| `TA_AUTH_PROXY_USERNAME_HEADER` | `HTTP_REMOTE_USER` | The name of the request header that the auth proxy passes to the proxied application (**Tube Archivist** in this case), so that the application can identify the user. Check the documentation of your auth proxy to get this information. - > ??? note - The request headers are rewritten within **Tube Archivist**: all HTTP headers are prefixed with `HTTP_`, all letters are in uppercase, and dashes are replaced with underscores.For example, for Authelia, which passes the `Remote-User` HTTP header, the `TA_AUTH_PROXY_USERNAME_HEADER` needs to be configured as `HTTP_REMOTE_USER`. | +| `TA_AUTH_PROXY_USERNAME_HEADER` | `HTTP_REMOTE_USER` | The name of the request header that the auth proxy passes to the proxied application (**Tube Archivist** in this case), so that the application can identify the user. Check the documentation of your auth proxy to get this information.[^1] | | `TA_AUTH_PROXY_LOGOUT_URL` | | The URL that **Tube Archivist** should redirect to after a logout. By default, the logout redirects to the login URL, which means the user will be automatically authenticated again. Instead, you might want to configure the logout URL of the auth proxy here. | +[^1]: + The request headers are rewritten within **Tube Archivist**: all HTTP headers are prefixed with `HTTP_`, all letters are in uppercase, and dashes are replaced with underscores.For example, for Authelia, which passes the `Remote-User` HTTP header, the `TA_AUTH_PROXY_USERNAME_HEADER` needs to be configured as `HTTP_REMOTE_USER`. \ No newline at end of file diff --git a/mkdocs/docs/installation/podman.md b/mkdocs/docs/installation/podman.md index 6c22cbd..83e7ac9 100644 --- a/mkdocs/docs/installation/podman.md +++ b/mkdocs/docs/installation/podman.md @@ -23,8 +23,8 @@ Edit the `docker-compose.yml` with these additional changes: prefix the container name with `docker.io/` again. - under `archivist-redis` > `expose`: change the whole entry from `expose: [""]` into `ports: [":"]`. - ???+ example - `ports: ["6379:6379"]` + > ???+ example + `ports: ["6379:6379"]` #### Elasticsearch @@ -32,8 +32,8 @@ Edit the `docker-compose.yml` with these additional changes: prefix the container name with `docker.io/` again. - under `archivist-es` > `expose`: change the whole entry from `expose: [""]` into `ports: [":"]`. - ???+ example - `ports: ["9200:9200"]` + > ???+ example + `ports: ["9200:9200"]` ### Create service files (optional) diff --git a/mkdocs/docs/installation/synology.md b/mkdocs/docs/installation/synology.md index a4cddc8..818d459 100644 --- a/mkdocs/docs/installation/synology.md +++ b/mkdocs/docs/installation/synology.md @@ -71,22 +71,22 @@ Once all of the folders have been created, it should have a folder structure wit 1. Open an SSH connection to the Synology. Login as your primary `Admin` user, or the user that was enabled for SSH access. 2. Elevate your access to `root`. Steps are provided [here](https://kb.synology.com/en-sg/DSM/tutorial/How_to_login_to_DSM_with_root_permission_via_SSH_Telnet). 3. Change directories to the **Volume** where the "Docker" folder resides. - !!! example "`cd /volume1`" + > !!! example "`cd /volume1`" 4. Change directories to the "Docker" folder. - !!! example "`cd Docker`" + > !!! example "`cd Docker`" 5. Change directories to the "TubeArchivist" folder. - !!! example "`cd TubeArchivist`" + > !!! example "`cd TubeArchivist`" 6. Change the owner of the "redis" folder. *If correct, this does not have an output.* - !!! example "`chown 999:100 redis`" + > !!! example "`chown 999:100 redis`" 7. Change the owner of the "es" folder. *If correct, this does not have an output.* - !!! example "`chown 1000:0 es`" + > !!! example "`chown 1000:0 es`" 8. Confirm that the folders have the correct permissions. - !!! example "`ls -hl`" + > !!! example "`ls -hl`" ![Synology - Docker Folder Permissions Command](../assets/Synology_0.3.6_Docker-Folder-Permissions-Commands.png) 9. Logout from root. - !!! example "`logout`" + > !!! example "`logout`" 10. Disconnect from the SSH connection. - !!! example "`exit`" + > !!! example "`exit`" ### Synology Docker Setup @@ -124,90 +124,90 @@ Once all of the folders have been created, it should have a folder structure wit #### 3. Configure ElasticSearch **ElasticSearch** - 1. Select the associated image. - 2. Click the **Launch** button in the top. - 3. Edit the **Container Name** to be "tubearchivist-es". - 4. Click on the **Advanced Settings** button. - 5. In the **Advanced Settings** tab, check the box for `Enable auto-restart`. - 6. In the **Volume** tab, click the **Add Folder** button and select the "`Docker/TubeArchivist/es`" folder, then type in `/usr/share/elasticsearch/data` for the mount path. - 7. In the **Network** tab, leave the default `bridge` Network (unless you have a specific Network design that you know how to implement). - 8. In the **Port Settings** tab, replace the "Auto" entry under **Local Port** with the port that will be used to connect to ElasticSearch (default is 9200). - 9. In the **Port Settings** tab, select the entryline for port 9300 and **➖ delete** the line. It is not needed for this container. - 10. The **Links** tab does not require configuration for this container. - 11. In the **Environment** tab, add in the following ElasticSearch specific environment variables that may apply. +1. Select the associated image. +2. Click the **Launch** button in the top. +3. Edit the **Container Name** to be "tubearchivist-es". +4. Click on the **Advanced Settings** button. +5. In the **Advanced Settings** tab, check the box for `Enable auto-restart`. +6. In the **Volume** tab, click the **Add Folder** button and select the "`Docker/TubeArchivist/es`" folder, then type in `/usr/share/elasticsearch/data` for the mount path. +7. In the **Network** tab, leave the default `bridge` Network (unless you have a specific Network design that you know how to implement). +8. In the **Port Settings** tab, replace the "Auto" entry under **Local Port** with the port that will be used to connect to ElasticSearch (default is 9200). +9. In the **Port Settings** tab, select the entryline for port 9300 and **➖ delete** the line. It is not needed for this container. +10. The **Links** tab does not require configuration for this container. +11. In the **Environment** tab, add in the following ElasticSearch specific environment variables that may apply. - | Environment Variable | Setting | - | :------------------- | :------ | - | `discovery.type | single-node` | - | `ES_JAVA_OPTS | -Xms512m -Xmx512m` | - | `UID | 1000` | - | `GID | 0` | - | `xpack.security.enabled | true` | - | `ELASTIC_PASSWORD | verysecret` | - | `path.repo | /usr/share/elasticsearch/data/snapshot` | +| Environment Variable | Setting | +| :------------------- | :------ | +| `discovery.type | single-node` | +| `ES_JAVA_OPTS | -Xms512m -Xmx512m` | +| `UID | 1000` | +| `GID | 0` | +| `xpack.security.enabled | true` | +| `ELASTIC_PASSWORD | verysecret` | +| `path.repo | /usr/share/elasticsearch/data/snapshot` | - > !!! danger "BE AWARE" - - Do not use the default password, as it is very insecure. - - Activating snapshots for backups should only be done *after* setting the `path.repo` setting. +!!! danger "BE AWARE" + - Do not use the default password, as it is very insecure. + - Activating snapshots for backups should only be done *after* setting the `path.repo` setting. - ![Synology - ElasticSearch Environment Configurations](../assets/Synology_0.2.0_Docker-ES-Env-Conf.png) +![Synology - ElasticSearch Environment Configurations](../assets/Synology_0.2.0_Docker-ES-Env-Conf.png) - 12. Click on the **Apply** button. - 13. Back on the **Create Container** screen, click the **Next** button. - 14. Review the settings to confirm, then click the **Apply** button. +12. Click on the **Apply** button. +13. Back on the **Create Container** screen, click the **Next** button. +14. Review the settings to confirm, then click the **Apply** button. #### 4. Configure Redis **Redis** - 1. Select the associated image. - 2. Click the **Launch** button in the top. - 3. Edit the **Container Name** to be "tubearchivist-redis". - 4. Click on the **Advanced Settings** button. - 5. In the **Advanced Settings** tab, check the box for `Enable auto-restart`. - 6. In the **Volume** tab, click the **Add Folder** button and select the "`Docker/TubeArchivist/redis`" folder, then type in `/data` for the mount path. - 7. In the **Network** tab, leave the default `bridge` Network (unless you have a specific Network design that you know how to implement). - 8. In the **Port Settings** tab, replace the "Auto" entry under **Local Port** with the port that will be used to connect to Redis (default is 6379). - 9. In the **Links** tab, select the `tubearchivist-es` container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-es". - 10. In the **Environment** tab, add in any Redis specific environment variables that may apply (none by default). - 11. Click on the **Apply** button. - 12. Back on the **Create Container** screen, click the **Next** button. - 13. Review the settings to confirm, then click the **Apply** button. +1. Select the associated image. +2. Click the **Launch** button in the top. +3. Edit the **Container Name** to be "tubearchivist-redis". +4. Click on the **Advanced Settings** button. +5. In the **Advanced Settings** tab, check the box for `Enable auto-restart`. +6. In the **Volume** tab, click the **Add Folder** button and select the "`Docker/TubeArchivist/redis`" folder, then type in `/data` for the mount path. +7. In the **Network** tab, leave the default `bridge` Network (unless you have a specific Network design that you know how to implement). +8. In the **Port Settings** tab, replace the "Auto" entry under **Local Port** with the port that will be used to connect to Redis (default is 6379). +9. In the **Links** tab, select the `tubearchivist-es` container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-es". +10. In the **Environment** tab, add in any Redis specific environment variables that may apply (none by default). +11. Click on the **Apply** button. +12. Back on the **Create Container** screen, click the **Next** button. +13. Review the settings to confirm, then click the **Apply** button. #### 5. Configure Tube Archivist **Tube Archivist** - 1. Select the associated image. - 2. Click the **Launch** button in the top. - 3. Edit the **Container Name** to be "tubearchivist". - 4. Click on the **Advanced Settings** button. - 5. In the **Advanced Settings** tab, check the box for `Enable auto-restart`. - 6. In the **Volume** tab, click the **Add Folder** button and select the "`Docker/TubeArchivist/cache`" folder, then type in `/cache` for the mount path. - 7. In the **Volume** tab, click the **Add Folder** button and select the "`Docker/TubeArchivist/media`" folder, then type in `/youtube` for the mount path. - 8. In the **Network** tab, leave the default `bridge` Network (unless you have a specific Network design that you know how to implement). - 9. In the **Port Settings** tab, replace the "Auto" entry under **Local Port** with the port that will be used to connect to **Tube Archivist** (default is 8000). - 10. In the **Links** tab, select the `tubearchivist-es` container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-es". - 11. In the **Links** tab, select the `tubearchivist-redis` container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-redis". - 12. In the **Environment** tab, add in the following **Tube Archivist** specific environment variables that may apply. **Change the variables as is appropriate to your use case. Follow the [README section](https://github.com/tubearchivist/tubearchivist#installing) for details on what to set each variable.** +1. Select the associated image. +2. Click the **Launch** button in the top. +3. Edit the **Container Name** to be "tubearchivist". +4. Click on the **Advanced Settings** button. +5. In the **Advanced Settings** tab, check the box for `Enable auto-restart`. +6. In the **Volume** tab, click the **Add Folder** button and select the "`Docker/TubeArchivist/cache`" folder, then type in `/cache` for the mount path. +7. In the **Volume** tab, click the **Add Folder** button and select the "`Docker/TubeArchivist/media`" folder, then type in `/youtube` for the mount path. +8. In the **Network** tab, leave the default `bridge` Network (unless you have a specific Network design that you know how to implement). +9. In the **Port Settings** tab, replace the "Auto" entry under **Local Port** with the port that will be used to connect to **Tube Archivist** (default is 8000). +10. In the **Links** tab, select the `tubearchivist-es` container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-es". +11. In the **Links** tab, select the `tubearchivist-redis` container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-redis". +12. In the **Environment** tab, add in the following **Tube Archivist** specific environment variables that may apply. **Change the variables as is appropriate to your use case. Follow the [README section](https://github.com/tubearchivist/tubearchivist#installing) for details on what to set each variable.** - | Environment Variable | Setting | - | :------------------- | :------ | - | `TA_HOST | synology.local` | - | `ES_URL | http://tubearchivist-es:9200` | - | `REDIS_HOST | tubearchivist-redis` | - | `HOST_UID | 1000` | - | `HOST_GID | 0` | - | `TA_USERNAME | tubearchivist` | - | `TA_PASSWORD | verysecret` | - | `ELASTIC_PASSWORD | verysecret` | - | `TZ | America/New_York` | +| Environment Variable | Setting | +| :------------------- | :------ | +| `TA_HOST | synology.local` | +| `ES_URL | http://tubearchivist-es:9200` | +| `REDIS_HOST | tubearchivist-redis` | +| `HOST_UID | 1000` | +| `HOST_GID | 0` | +| `TA_USERNAME | tubearchivist` | +| `TA_PASSWORD | verysecret` | +| `ELASTIC_PASSWORD | verysecret` | +| `TZ | America/New_York` | - > !!! danger "BE AWARE" - - Do not use the default password as it is very insecure. - - Ensure that ELASTIC_PASSWORD matches the password used on the `tubearchivist-es` container. +!!! danger "BE AWARE" + - Do not use the default password as it is very insecure. + - Ensure that ELASTIC_PASSWORD matches the password used on the `tubearchivist-es` container. - ![Synology - Tube Archivist Environment Configurations](../assets/Synology_0.2.0_Docker-TA-Env-Conf.png) +![Synology - Tube Archivist Environment Configurations](../assets/Synology_0.2.0_Docker-TA-Env-Conf.png) - 13. Click on the **Apply** button. - 14. Back on the **Create Container** screen, click the **Next** button. - 15. Review the settings to confirm, then click the **Apply** button. +13. Click on the **Apply** button. +14. Back on the **Create Container** screen, click the **Next** button. +15. Review the settings to confirm, then click the **Apply** button. ### 6. Post-Installation Monitoring @@ -228,7 +228,7 @@ Once all of the folders have been created, it should have a folder structure wit ### Synology Docker Upgrade When a new version of the image is available, you can use the following steps to more easily upgrade your previous instance. -!!! failure `latest` Tag Required +!!! failure "`latest` Tag Required" If you did not use the `latest` tag, you may have some variances in your upgrade steps. Those are detailed below these instructions. 1. Go to the Registry Tab and download the newest instance of the `:latest` tag, as seen in the Installation Instructions earlier. 2. Go to Image Tab and confirm that you have the newer version available. diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml index c1693d6..e3023e0 100644 --- a/mkdocs/mkdocs.yml +++ b/mkdocs/mkdocs.yml @@ -55,6 +55,7 @@ markdown_extensions: - pymdownx.details - pymdownx.superfences - tables + - footnotes theme: name: material logo: assets/logo-dark.jpg