From 721927c5ca4aaca660cc6177bab99b6895e8b4d4 Mon Sep 17 00:00:00 2001 From: Arimil Date: Fri, 22 Nov 2024 05:37:06 -0500 Subject: [PATCH 1/4] Update TrueNAS instructions to better align with TrueNAS 24.10 docker changes --- .../installing-shoko-server.md | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/getting-started/installing-shoko-server.md b/docs/getting-started/installing-shoko-server.md index 7abf654..70f398a 100644 --- a/docs/getting-started/installing-shoko-server.md +++ b/docs/getting-started/installing-shoko-server.md @@ -20,12 +20,7 @@ const containerData = [ name: 'PGID', value: '568', description: 'Group ID for the Shoko server', - }, - { - name: 'TZ', - value: 'Etc/UTC', - description: 'Timezone for the container see: [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)', - }, + } ]; @@ -139,35 +134,40 @@ Follow these steps to set up a Shoko server using a custom app: 1. Navigate to **Apps -> Discover Apps -> Custom App**. 2. Set the **Application Name** to your preference. -3. Configure **Container Images**: - - Image Repository: `ghcr.io/shokoanime/server` - - Image Tag: `latest` -4. Set **Container Environment Variables**: - - These settings ensure Shoko runs as the built-in `Apps` user. Verify this user has access to your media folder. +3. Configure **Image Configuration**: + - Repository: `ghcr.io/shokoanime/server` + - Tag: `latest` +4. Set **Container Configuration**: + - Environment Variables: -5. Configure **Port Forwarding**: + (These settings ensure Shoko runs as the built-in `Apps` user. Verify this user has access to your media folder.) + - Restart Policy: `Unless Stopped - Restarts the container irrespective of the exit code but stops restarting when the service is stopped or removed.` +6. Configure **Network Configuration**: + - Add a new port - Container Port: `8111` - - Node Port: Choose any available port + - Host Port: `8111` + - Protocol: `TCP` - Extra for Truenas EE: - Container Port: `4556` - Host Port: `4556` - Protocol: `udp` -6. Set up **Storage**: +7. Portal Configuration (**Optional**): + - Add a portal + - Name: `Web UI` + - Protocl: `HTTP` + - Use Node IP: `checked` + - Port: Use the Node Port from step 5. This allows access to the Shoko Web UI via the App's Web Portal. + - Path: `/` +8. **Storage Coonfiguration**: - **Optional**: Mount Shoko config -> If not mounted the DB will be lost on container restart - Host Path: Path to store Shoko config - Mount Path: `/home/shoko/.shoko` - **Required**: Mount media folder - Host Path: Your media folder location - Mount Path: Desired container media folder path -7. Portal Configuration (**Optional**): - - Enable WebUiPortal: Checked - - Port: Use the Node Port from step 5. This allows access to the Shoko Web UI via the App's Web Portal. -8. Container User and Group ID: - - If desired, leave as default to run as root. - - Configure to run with a user that has permission to modify files. Note: The Docker startup script will attempt to - create a Shoko user and may fail to start if unsuccessful. -9. Click **Save** and wait for the container status to change to "Running". -10. Access the setup page by clicking **Web Portal** under Application Info. + +10. Click **Save** and wait for the container status to change to "Running". +11. Access the setup page by clicking **Web UI** under Application Info. ### Common Issues From a36240061fd6242a64ee29f5d185c4a598739d97 Mon Sep 17 00:00:00 2001 From: Arimil Date: Fri, 22 Nov 2024 05:41:29 -0500 Subject: [PATCH 2/4] add timezone to container configuration setps --- docs/getting-started/installing-shoko-server.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/getting-started/installing-shoko-server.md b/docs/getting-started/installing-shoko-server.md index 70f398a..61e6393 100644 --- a/docs/getting-started/installing-shoko-server.md +++ b/docs/getting-started/installing-shoko-server.md @@ -138,6 +138,7 @@ Follow these steps to set up a Shoko server using a custom app: - Repository: `ghcr.io/shokoanime/server` - Tag: `latest` 4. Set **Container Configuration**: + - Timezone: set to your local timezone - Environment Variables: (These settings ensure Shoko runs as the built-in `Apps` user. Verify this user has access to your media folder.) From afbcdcd32f78131abc285b73fccbad768863e325 Mon Sep 17 00:00:00 2001 From: Arimil Date: Fri, 22 Nov 2024 05:42:54 -0500 Subject: [PATCH 3/4] fix typo in configuration --- docs/getting-started/installing-shoko-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/installing-shoko-server.md b/docs/getting-started/installing-shoko-server.md index 61e6393..ceec1d3 100644 --- a/docs/getting-started/installing-shoko-server.md +++ b/docs/getting-started/installing-shoko-server.md @@ -159,7 +159,7 @@ Follow these steps to set up a Shoko server using a custom app: - Use Node IP: `checked` - Port: Use the Node Port from step 5. This allows access to the Shoko Web UI via the App's Web Portal. - Path: `/` -8. **Storage Coonfiguration**: +8. **Storage Configuration**: - **Optional**: Mount Shoko config -> If not mounted the DB will be lost on container restart - Host Path: Path to store Shoko config - Mount Path: `/home/shoko/.shoko` From b96545aa443894d37e2debcbd55ad8358400cb5f Mon Sep 17 00:00:00 2001 From: Arimil Date: Fri, 22 Nov 2024 05:44:42 -0500 Subject: [PATCH 4/4] fix numbering for TrueNAS setps --- docs/getting-started/installing-shoko-server.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/installing-shoko-server.md b/docs/getting-started/installing-shoko-server.md index ceec1d3..d3cf88a 100644 --- a/docs/getting-started/installing-shoko-server.md +++ b/docs/getting-started/installing-shoko-server.md @@ -167,8 +167,8 @@ Follow these steps to set up a Shoko server using a custom app: - Host Path: Your media folder location - Mount Path: Desired container media folder path -10. Click **Save** and wait for the container status to change to "Running". -11. Access the setup page by clicking **Web UI** under Application Info. +9. Click **Save** and wait for the container status to change to "Running". +10. Access the setup page by clicking **Web UI** under Application Info. ### Common Issues