tubearchivist
/
docs
mirror of https://github.com/tubearchivist/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Additional formatting fixes. Replacing one admonition with footnote. Adding footnotes feature.

This commit is contained in:
lamusmaser 2024-04-20 05:48:55 -06:00
parent f68fc49fc6
commit dfc66873db
4 changed files with 87 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
mkdocs/docs/configuration/forward-auth.md
View File

@ -9,7 +9,7 @@ Note that this automatically creates new users in the database if they do not al
| Environment Variable | Example | Description | | Environment Variable | Example | Description |
| :------------------- | :------ | :---------- | | :------------------- | :------ | :---------- |
| `TA_ENABLE_AUTH_PROXY` | `true` | Set to anything besides empty string to use forward proxy authentication. | | `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. | `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] |
> ??? 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_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. | | `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`.

8
mkdocs/docs/installation/podman.md
View File

@ -23,8 +23,8 @@ Edit the `docker-compose.yml` with these additional changes:
prefix the container name with `docker.io/` again. prefix the container name with `docker.io/` again.
- under `archivist-redis` > `expose`: - under `archivist-redis` > `expose`:
change the whole entry from `expose: ["<PORT>"]` into `ports: ["<PORT>:<PORT>"]`. change the whole entry from `expose: ["<PORT>"]` into `ports: ["<PORT>:<PORT>"]`.
???+ example > ???+ example
`ports: ["6379:6379"]` `ports: ["6379:6379"]`
#### Elasticsearch #### Elasticsearch
@ -32,8 +32,8 @@ Edit the `docker-compose.yml` with these additional changes:
prefix the container name with `docker.io/` again. prefix the container name with `docker.io/` again.
- under `archivist-es` > `expose`: - under `archivist-es` > `expose`:
change the whole entry from `expose: ["<PORT>"]` into `ports: ["<PORT>:<PORT>"]`. change the whole entry from `expose: ["<PORT>"]` into `ports: ["<PORT>:<PORT>"]`.
???+ example > ???+ example
`ports: ["9200:9200"]` `ports: ["9200:9200"]`
### Create service files (optional) ### Create service files (optional)

158
mkdocs/docs/installation/synology.md
View File

@ -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. 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). 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. 3. Change directories to the **Volume** where the "Docker" folder resides.
!!! example "`cd /volume1`" > !!! example "`cd /volume1`"
4. Change directories to the "Docker" folder. 4. Change directories to the "Docker" folder.
!!! example "`cd Docker`" > !!! example "`cd Docker`"
5. Change directories to the "TubeArchivist" folder. 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.* 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.* 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. 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) ![Synology - Docker Folder Permissions Command](../assets/Synology_0.3.6_Docker-Folder-Permissions-Commands.png)
9. Logout from root. 9. Logout from root.
!!! example "`logout`" > !!! example "`logout`"
10. Disconnect from the SSH connection. 10. Disconnect from the SSH connection.
!!! example "`exit`" > !!! example "`exit`"
### Synology Docker Setup ### 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 #### 3. Configure ElasticSearch
**ElasticSearch** **ElasticSearch**
1. Select the associated image. 1. Select the associated image.
2. Click the **Launch** button in the top. 2. Click the **Launch** button in the top.
3. Edit the **Container Name** to be "tubearchivist-es". 3. Edit the **Container Name** to be "tubearchivist-es".
4. Click on the **Advanced Settings** button. 4. Click on the **Advanced Settings** button.
5. In the **Advanced Settings** tab, check the box for `Enable auto-restart`. 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. 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). 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). 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. 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. 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. 11. In the **Environment** tab, add in the following ElasticSearch specific environment variables that may apply.
| Environment Variable | Setting | | Environment Variable | Setting |
| :------------------- | :------ | | :------------------- | :------ |
| `discovery.type | single-node` | | `discovery.type | single-node` |
| `ES_JAVA_OPTS | -Xms512m -Xmx512m` | | `ES_JAVA_OPTS | -Xms512m -Xmx512m` |
| `UID | 1000` | | `UID | 1000` |
| `GID | 0` | | `GID | 0` |
| `xpack.security.enabled | true` | | `xpack.security.enabled | true` |
| `ELASTIC_PASSWORD | verysecret` | | `ELASTIC_PASSWORD | verysecret` |
| `path.repo | /usr/share/elasticsearch/data/snapshot` | | `path.repo | /usr/share/elasticsearch/data/snapshot` |
> !!! danger "BE AWARE" !!! danger "BE AWARE"
- Do not use the default password, as it is very insecure. - 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. - 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. 12. Click on the **Apply** button.
13. Back on the **Create Container** screen, click the **Next** button. 13. Back on the **Create Container** screen, click the **Next** button.
14. Review the settings to confirm, then click the **Apply** button. 14. Review the settings to confirm, then click the **Apply** button.
#### 4. Configure Redis #### 4. Configure Redis
**Redis** **Redis**
1. Select the associated image. 1. Select the associated image.
2. Click the **Launch** button in the top. 2. Click the **Launch** button in the top.
3. Edit the **Container Name** to be "tubearchivist-redis". 3. Edit the **Container Name** to be "tubearchivist-redis".
4. Click on the **Advanced Settings** button. 4. Click on the **Advanced Settings** button.
5. In the **Advanced Settings** tab, check the box for `Enable auto-restart`. 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. 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). 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). 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". 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). 10. In the **Environment** tab, add in any Redis specific environment variables that may apply (none by default).
11. Click on the **Apply** button. 11. Click on the **Apply** button.
12. Back on the **Create Container** screen, click the **Next** button. 12. Back on the **Create Container** screen, click the **Next** button.
13. Review the settings to confirm, then click the **Apply** button. 13. Review the settings to confirm, then click the **Apply** button.
#### 5. Configure Tube Archivist #### 5. Configure Tube Archivist
**Tube Archivist** **Tube Archivist**
1. Select the associated image. 1. Select the associated image.
2. Click the **Launch** button in the top. 2. Click the **Launch** button in the top.
3. Edit the **Container Name** to be "tubearchivist". 3. Edit the **Container Name** to be "tubearchivist".
4. Click on the **Advanced Settings** button. 4. Click on the **Advanced Settings** button.
5. In the **Advanced Settings** tab, check the box for `Enable auto-restart`. 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. 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. 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). 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). 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". 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". 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.** 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 | | Environment Variable | Setting |
| :------------------- | :------ | | :------------------- | :------ |
| `TA_HOST | synology.local` | | `TA_HOST | synology.local` |
| `ES_URL | http://tubearchivist-es:9200` | | `ES_URL | http://tubearchivist-es:9200` |
| `REDIS_HOST | tubearchivist-redis` | | `REDIS_HOST | tubearchivist-redis` |
| `HOST_UID | 1000` | | `HOST_UID | 1000` |
| `HOST_GID | 0` | | `HOST_GID | 0` |
| `TA_USERNAME | tubearchivist` | | `TA_USERNAME | tubearchivist` |
| `TA_PASSWORD | verysecret` | | `TA_PASSWORD | verysecret` |
| `ELASTIC_PASSWORD | verysecret` | | `ELASTIC_PASSWORD | verysecret` |
| `TZ | America/New_York` | | `TZ | America/New_York` |
> !!! danger "BE AWARE" !!! danger "BE AWARE"
- Do not use the default password as it is very insecure. - Do not use the default password as it is very insecure.
- Ensure that ELASTIC_PASSWORD matches the password used on the `tubearchivist-es` container. - 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. 13. Click on the **Apply** button.
14. Back on the **Create Container** screen, click the **Next** button. 14. Back on the **Create Container** screen, click the **Next** button.
15. Review the settings to confirm, then click the **Apply** button. 15. Review the settings to confirm, then click the **Apply** button.
### 6. Post-Installation Monitoring ### 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 ### 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. 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. 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. 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. 2. Go to Image Tab and confirm that you have the newer version available.

1
mkdocs/mkdocs.yml
View File

@ -55,6 +55,7 @@ markdown_extensions:
- pymdownx.details - pymdownx.details
- pymdownx.superfences - pymdownx.superfences
- tables - tables
- footnotes
theme: theme:
name: material name: material
logo: assets/logo-dark.jpg logo: assets/logo-dark.jpg