tubearchivist/docs
1
0
Fork 0
mirror of https://github.com/tubearchivist/docs.git synced 2024-11-25 21:20:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #37 from lamusmaser/batch-editing

Browse Source 
Batch editing
This commit is contained in:
lamusmaser 2024-04-20 05:59:55 -06:00 committed by GitHub
commit a9c19e9d1a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 59 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -23,7 +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,7 +33,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)

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

@ -71,21 +71,37 @@ 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`"
@ -124,6 +140,7 @@ 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".
@ -138,13 +155,13 @@ Once all of the folders have been created, it should have a folder structure wit
| 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.
@ -157,7 +174,9 @@ Once all of the folders have been created, it should have a folder structure wit
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".
@ -173,7 +192,9 @@ Once all of the folders have been created, it should have a folder structure wit
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".
@ -189,15 +210,15 @@ Once all of the folders have been created, it should have a folder structure wit
| 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.
@ -211,14 +232,14 @@ Once all of the folders have been created, it should have a folder structure wit
### 6. Post-Installation Monitoring ### 6. Post-Installation Monitoring
6. After the containers have been configured and started, you can go to the **Container** tab and monitor the containers. 1. After the containers have been configured and started, you can go to the **Container** tab and monitor the containers.
7. To review the logs to ensure that the system has started successfully, select the `tubearchivist` container and click on the **Details** button. In the new window, go to the **Log** tab. Monitor the logs until either an error occurs or the message `celery@tubearchivist ready.` is in the logs. This may take a few minutes, especially for a first time setup. 2. To review the logs to ensure that the system has started successfully, select the `tubearchivist` container and click on the **Details** button. In the new window, go to the **Log** tab. Monitor the logs until either an error occurs or the message `celery@tubearchivist ready.` is in the logs. This may take a few minutes, especially for a first time setup.
> !!! note "Reviewing Logs" > !!! note "Reviewing Logs"
Synology Docker presents the logs in a paginated format, showing in historical order (oldest first). Synology Docker presents the logs in a paginated format, showing in historical order (oldest first).
If you are not seeing the logs update, check if there are additional pages. If you are not seeing the logs update, check if there are additional pages.
8. After it has started, go to the location provided in the `TA_HOST`. This should give you the standard **Tube Archivist** login screen. 3. After it has started, go to the location provided in the `TA_HOST`. This should give you the standard **Tube Archivist** login screen.
<!-- <!--
### Docker-Compose Setup --> ### Docker-Compose Setup -->
<!-- This section is a Work In Progress --> <!-- This section is a Work In Progress -->