Skip to content

Commit

Permalink
Update endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
GilbN committed Sep 30, 2023
1 parent 03e008a commit 07899a2
Show file tree
Hide file tree
Showing 12 changed files with 48 additions and 45 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# tp-docs

Wiki for [https://github.com/GilbN/theme.park/](https://github.com/GilbN/theme.park/)
Wiki for [https://github.com/themepark-dev/theme.park/](https://github.com/themepark-dev/theme.park/)
13 changes: 8 additions & 5 deletions docs/custom/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Custom Themes

To create your own theme options you only need the change the color variables. You dont need the edit the `<app>-base.css`. You can find the theme variables here [https://github.com/GilbN/theme.park/tree/master/css/theme-options](https://github.com/GilbN/theme.park/tree/master/css/theme-options)
To create your own theme options you only need the change the color variables. You dont need the edit the `<app>-base.css`. You can find the theme variables here [https://github.com/themepark-dev/theme.park/tree/master/css/theme-options](https://github.com/themepark-dev/theme.park/tree/master/css/theme-options)

You can either fork the repo and setup a [Github pages](https://pages.github.com/) site or clone it to your web server and serve the files that way.

Expand All @@ -16,7 +16,7 @@ See [docker](/setup#docker) for more information on selfhosting a docker image

1. Start with forking the the repo to the account you want.

2. Next head over to your theme.park fork and change the domain in the [CNAME](https://github.com/GilbN/theme.park/blob/master/CNAME) file to a custom domain if you have one or `<user>.github.io` ie `gilbn.github.io`
2. Next head over to your theme.park fork and change the domain in the [CNAME](https://github.com/themepark-dev/theme.park/blob/master/CNAME) file to a custom domain if you have one or `<user>.github.io` ie `gilbn.github.io`

1. Click on `Settings`, then select `Pages` on the left side menu.
Set your Source as `Deploy from a branch` and select the `live` branch.
Expand All @@ -27,9 +27,12 @@ See [docker](/setup#docker) for more information on selfhosting a docker image

![](minifyanddeploy.png)

This [workflow](https://github.com/GilbN/theme.park/blob/master/.github/workflows/minify-and-deploy.yml) will in short:
!!! Warning
Make sure the workflow has read and write write permissions to the repo. Go to: Repo -> Settings -> Actions -> General, scroll down to `Workflow permissions`and check `Read and write permissions` then hit `Save`

1. Run the [themes.py](https://github.com/GilbN/theme.park/blob/master/themes.py) script.
This [workflow](https://github.com/themepark-dev/theme.park/blob/master/.github/workflows/minify-and-deploy.yml) will in short:

1. Run the [themes.py](https://github.com/themepark-dev/theme.park/blob/master/themes.py) script.

2. [Minify](https://developer.mozilla.org/en-US/docs/Glossary/minification) the css files.

Expand All @@ -40,7 +43,7 @@ See [docker](/setup#docker) for more information on selfhosting a docker image

You can read more about how to add a custom domain here: https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site

3. The execution of the themes.py script is important as it creates all the theme files in all the base folders -> https://github.com/GilbN/theme.park/tree/live/css/base/. These files contains css `@imports` to both the base.css file and the theme-option.css file. By doing this you can easily use the files by using `user.github.io/theme.park/css/base/<app>/<theme-option>` ie https://gilbn.github.io/theme.park/css/base/radarr/plex.css. If you compare the `master` and `live` branch you can see master only contains the base css file.
3. The execution of the themes.py script is important as it creates all the theme files in all the base folders -> https://github.com/themepark-dev/theme.park/tree/live/css/base/. These files contains css `@imports` to both the base.css file and the theme-option.css file. By doing this you can easily use the files by using `user.github.io/theme.park/css/base/<app>/<theme-option>` ie https://gilbn.github.io/theme.park/css/base/radarr/plex.css. If you compare the `master` and `live` branch you can see master only contains the base css file.

3. After the deploy action is finished, you should be able to access https://username.github.io/theme.park/css/base/radarr/nord.css.

Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
![banner](site_assets/logo_banner.png)
[![Docs](https://img.shields.io/static/v1.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=theme-park.dev&message=Docs)](https://docs.theme-park.dev "Documentation for all the themes in this repository.")
[![Discord](https://img.shields.io/discord/591352397830553601.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/HM5uUKU "Discord for theme installation support")
[![GitHub Stars](https://img.shields.io/github/stars/gilbn/theme.park.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/GilbN/theme.park)
[![GitHub Stars](https://img.shields.io/github/stars/themepark-dev/theme.park.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/themepark-dev/theme.park)
[![Support](https://img.shields.io/static/v1.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=&message=sponsor&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABN0lEQVQ4T2NkoBAwIuv/HxDggMT/wLhhwwUQ/39AgAEDA4MATI5xw4YDcDaaAf+R+AcZN2wAG/g/IACkwR7JALjFYAbU5v0k+sYR5BLG/wEBCQwMDAUMDAz6DM3NDAxz5zIwPHhAjFkXGRgYJoAMaGBgYKgH6wgPZ2DYt4+B4fVrYgwAqWlENYBYbQwMDO8+sjH8+cvUSbYB6w9Kv/vwlW0aWYE4Z5MCAwfrf7fYnxN3wwwAxTEorvHGBMjZBy+Ivvv6jSXi20+OU+kMnR/RExIoQEGxIo8eHM/fcDA8fc114/J9/jVJv/prsSYkaJqYwMDAEIBsCMjme894bl6+w7s76e/EXGTDUVwAk0CJWgYGBliAIduM0wVIhoCS8X7kAMMWy1hdAPUKOGCXbJdnhQUYSQYQm6YAtdh8zhSGm1AAAAAASUVORK5CYII=)](https://github.com/sponsors/GilbN "Donate!")
[![GitHub](https://img.shields.io/github/license/gilbn/theme.park.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://github.com/gilbN/theme.park/blob/master/LICENSE)
[![GitHub](https://img.shields.io/github/license/themepark-dev/theme.park.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://github.com/themepark-dev/theme.park/blob/master/LICENSE)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=theme-park.dev&message=Packages&logo=github)](https://github.com/users/GilbN/packages/container/package/theme.park)
[![Docker Pulls](https://img.shields.io/docker/pulls/gilbn/theme.park.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/gilbn/theme.park)
[![Docker Pulls](https://img.shields.io/docker/pulls/themepark-dev/theme.park.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/themepark-dev/theme.park)
[![Blog](https://img.shields.io/static/v1.svg?color=009688&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=technicalramblings&message=Blog)](https://technicalramblings.com/ "A blog with different guides :)")

Here you will find an overview over all the themes in the repo and the documentation to get everything running.
Expand Down
26 changes: 13 additions & 13 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,11 @@ For [linuxserver.io](https://blog.linuxserver.io/2019/09/14/customizing-our-cont
!!! warning
Not all apps support this installation method. See the list to the left on the [themes](/themes/sonarr) overview. Look for the 🐳 icon.

[https://github.com/GilbN/theme.park/tree/master/docker-mods](https://github.com/GilbN/theme.park/tree/master/docker-mods)
[https://github.com/themepark-dev/theme.park/tree/master/docker-mods](https://github.com/themepark-dev/theme.park/tree/master/docker-mods)

This will inject the stylesheet directly into the app. This means that you don't need to use NGINX or stylus. Since it's injected into the HTML in the app, it will work locally too.

Add the variable `DOCKER_MODS=ghcr.io/gilbn/theme.park:<app>` e.g. `ghcr.io/gilbn/theme.park:sonarr`
Add the variable `DOCKER_MODS=ghcr.io/themepark-dev/theme.park:<app>` e.g. `ghcr.io/themepark-dev/theme.park:sonarr`

These are the **default** values for all envs. So if you want to use the `organizr` theme, you only need to add the `DOCKER_MODS` variable.

Expand All @@ -87,7 +87,7 @@ These are the **default** values for all envs. So if you want to use the `organi

| Environment Variable | Example Value | Description |
| -------------------- | ------------- | ----------- |
| `DOCKER_MODS` | `ghcr.io/gilbn/theme.park:<app>` | Replace <app\> |
| `DOCKER_MODS` | `ghcr.io/themepark-dev/theme.park:<app>` | Replace <app\> |
| `TP_DOMAIN` | `theme-park.dev` | `Optional` Defaults to the example. If you selfhost and use subfolder, you must escape the forward slash. `domain.com\/themepark` |
| `TP_THEME` | `organizr` | `Optional` The [theme-option](/theme-options) you want to use. Defaults to the example. |
| `TP_COMMUNITY_THEME` | `true` | `Optional` Set to true if you are using a [community theme option](/community-themes/) |
Expand All @@ -110,7 +110,7 @@ services:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- DOCKER_MODS=ghcr.io/gilbn/theme.park:sonarr
- DOCKER_MODS=ghcr.io/themepark-dev/theme.park:sonarr
volumes:
- /path/to/data:/config
- /path/to/media:/media
Expand All @@ -125,7 +125,7 @@ docker run -d \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e DOCKER_MODS=ghcr.io/gilbn/theme.park:sonarr \
-e DOCKER_MODS=ghcr.io/themepark-dev/theme.park:sonarr \
-p 8989:8989 \
-v /path/to/data:/config \
-v /path/to/media:/media \
Expand All @@ -142,10 +142,10 @@ docker run -d \
The script must be mounted using a volume mount. See [https://hotio.dev/faq/#guides](https://hotio.dev/faq/#guides).

!!! info
The scripts are located in the docker-mods folder. [https://github.com/GilbN/theme.park/tree/master/docker-mods](https://github.com/GilbN/theme.park/tree/master/docker-mods)
The scripts are located in the docker-mods folder. [https://github.com/themepark-dev/theme.park/tree/master/docker-mods](https://github.com/themepark-dev/theme.park/tree/master/docker-mods)
You can download all the scripts using the [download script below](#download-script)

Go to `<app>/root/etc/cont-init.d/` to find the different scripts. e.g. [/sonarr/root/etc/cont-init.d/98-themepark](https://github.com/GilbN/theme.park/blob/master/docker-mods/sonarr/root/etc/cont-init.d/98-themepark)
Go to `<app>/root/etc/cont-init.d/` to find the different scripts. e.g. [/sonarr/root/etc/cont-init.d/98-themepark](https://github.com/themepark-dev/theme.park/blob/master/docker-mods/sonarr/root/etc/cont-init.d/98-themepark)

!!! note
Make sure the script is executable! The [download script](#download-script) will `chmod +x` all files, but if you download manually, you need to run the chmod command on the file.
Expand All @@ -158,7 +158,7 @@ This script will download all mods/scripts into the path you choose.

Defaults to `/tmp/theme-park-mods` is no path argument is passed.

See script contents here: https://github.com/GilbN/theme.park/blob/master/fetch.sh
See script contents here: https://github.com/themepark-dev/theme.park/blob/master/fetch.sh

```bash
sudo apt-get install jq curl
Expand Down Expand Up @@ -298,7 +298,7 @@ You can also use `/themepark` to access the files. The subfolder path can be ove
version: "2.1"
services:
theme-park:
image: ghcr.io/gilbn/theme.park
image: ghcr.io/themepark-dev/theme.park
container_name: theme-park
environment:
- PUID=1000
Expand All @@ -324,7 +324,7 @@ docker run -d \
-p 4443:443 \
-v /path/to/data:/config `#optional` \
--restart unless-stopped \
ghcr.io/gilbn/theme.park
ghcr.io/themepark-dev/theme.park
```

***
Expand Down Expand Up @@ -394,7 +394,7 @@ services:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- DOCKER_MODS=ghcr.io/gilbn/theme.park:sonarr
- DOCKER_MODS=ghcr.io/themepark-dev/theme.park:sonarr
- TP_SCHEME=http
- TP_DOMAIN=192.168.1.99:8080\/themepark # forward slash needs to be escaped with a \
volumes:
Expand All @@ -404,7 +404,7 @@ services:
- 8989:8989
restart: unless-stopped
theme-park:
image: ghcr.io/gilbn/theme.park
image: ghcr.io/themepark-dev/theme.park
container_name: theme-park
environment:
- PUID=1000
Expand Down Expand Up @@ -435,7 +435,7 @@ See their docs for more information. [https://docs.k8s-at-home.com/](https://doc
This will download the CSS files into your [SWAG](https://docs.linuxserver.io/general/swag) appdata folder. (`/config/www/themepark`)
Files are downloaded using svn, so the svn package will be installed on the container.

Add the variable `DOCKER_MODS=ghcr.io/gilbn/theme.park:swag` to your SWAG container.
Add the variable `DOCKER_MODS=ghcr.io/themepark-dev/theme.park:swag` to your SWAG container.

***

Expand Down
2 changes: 1 addition & 1 deletion docs/themes/addons/organizr/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Here are the other theme colors if you want to use that instead:
<img src="plex_banner.png" width="600px" />

```css
--mobile-bg-color: url("https://raw.githubusercontent.com/gilbN/theme.park/master/Resources/blur-noise.png"), url("https://raw.githubusercontent.com/gilbN/theme.park/master/Resources/preset-light2.png") center center/cover no-repeat fixed;
--mobile-bg-color: url("https://raw.githubusercontent.com/themepark-dev/theme.park/master/Resources/blur-noise.png"), url("https://raw.githubusercontent.com/themepark-dev/theme.park/master/Resources/preset-light2.png") center center/cover no-repeat fixed;
```

!!! note
Expand Down
8 changes: 4 additions & 4 deletions docs/themes/addons/unraid/login-page/alien/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Custom Alien themed css for the Unraid login page.

**Recommended way:**

Install using the [bash script](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh) and the plugin [CA User Scripts](https://forums.unraid.net/topic/48286-plugin-ca-user-scripts/)
Install using the [bash script](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh) and the plugin [CA User Scripts](https://forums.unraid.net/topic/48286-plugin-ca-user-scripts/)

Add a new user script by clicking `Add new script`

Expand All @@ -27,7 +27,7 @@ Click or hover over the gear icon and click `Edit Script`

![edit](../assets/edit.png)

Paste the contents of the bash script: [custom_login.sh](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh)
Paste the contents of the bash script: [custom_login.sh](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh)

Below the shebang(`#!/bin/bash`) are the variables you need to change for the different themes.

Expand All @@ -51,7 +51,7 @@ DISABLE_THEME="false"

See [screenshots](#screenshots) at the bottom.

Available wallpapers [Wallpapers](https://github.com/gilbN/theme.park/tree/master/css/addons/unraid/login-page/alien/wallpaper)
Available wallpapers [Wallpapers](https://github.com/themepark-dev/theme.park/tree/master/css/addons/unraid/login-page/alien/wallpaper)

```css
hallway.css
Expand Down Expand Up @@ -88,7 +88,7 @@ You can also inject an animated video wallpaper from the Isolation video game.

***You should probably have a look at the content of that file, and probably host it yourself 💀***

[isolation.js](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/alien/js/isolation.js)
[isolation.js](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/alien/js/isolation.js)

⚠️⚠️⚠️

Expand Down
14 changes: 7 additions & 7 deletions docs/themes/addons/unraid/login-page/fallout/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Custom Fallout themed css for the Unraid login page.

**Recommended way:**

Install using the [bash script](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh) and the plugin [CA User Scripts](https://forums.unraid.net/topic/48286-plugin-ca-user-scripts/)
Install using the [bash script](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh) and the plugin [CA User Scripts](https://forums.unraid.net/topic/48286-plugin-ca-user-scripts/)

Add a new user script by clicking `Add new script`

Expand All @@ -28,7 +28,7 @@ Click or hover over the gear icon and click `Edit Script`

![edit](../assets/edit.png)

Paste the contents of the bash script: [custom_login.sh](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh)
Paste the contents of the bash script: [custom_login.sh](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh)

Below the shebang(`#!/bin/bash`) are the variables you need to change for the different themes.

Expand All @@ -52,7 +52,7 @@ DISABLE_THEME="false"

See [screenshots](#screenshots) at the bottom.

Available wallpapers [Wallpapers](https://github.com/gilbN/theme.park/tree/master/css/addons/unraid/login-page/fallout/wallpaper)
Available wallpapers [Wallpapers](https://github.com/themepark-dev/theme.park/tree/master/css/addons/unraid/login-page/fallout/wallpaper)

```css
terminal.css
Expand All @@ -79,7 +79,7 @@ You can also inject an animated video wallpaper.

1. Set `THEME` to `fallout_video.css`
2. Set `ADD_JS` to `"true"` to enable.
3. Choose the video you want. See: [videos](https://github.com/gilbN/theme.park/tree/master/css/addons/unraid/login-page/fallout/video)
3. Choose the video you want. See: [videos](https://github.com/themepark-dev/theme.park/tree/master/css/addons/unraid/login-page/fallout/video)
* Available js: `please_stand_by.js`, `vault-tec-crt.js`, `vault-tec-crt_no-scanline.js`
4. Set `JS` to the one you want.

Expand All @@ -89,11 +89,11 @@ You can also inject an animated video wallpaper.

***You should probably have a look at the content of that file, and probably host it yourself 💀***

[please_stand_by.js](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/fallout/js/please_stand_by.js)
[please_stand_by.js](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/fallout/js/please_stand_by.js)

[vault-tec-crt.js](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/fallout/js/vault-tec-crt.js)
[vault-tec-crt.js](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/fallout/js/vault-tec-crt.js)

[vault-tec-crt_no-scanline.js](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/fallout/js/vault-tec-crt_no-scanline.js)
[vault-tec-crt_no-scanline.js](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/fallout/js/vault-tec-crt_no-scanline.js)

⚠️⚠️⚠️

Expand Down
6 changes: 3 additions & 3 deletions docs/themes/addons/unraid/login-page/retro-terminal/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Animated custom css for the Unraid login page.

**Recommended way:**

Install using the [bash script](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh) and the plugin [CA User Scripts](https://forums.unraid.net/topic/48286-plugin-ca-user-scripts/)
Install using the [bash script](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh) and the plugin [CA User Scripts](https://forums.unraid.net/topic/48286-plugin-ca-user-scripts/)

Add a new user script by clicking `Add new script`

Expand All @@ -30,7 +30,7 @@ Click or hover over the gear icon and click `Edit Script`

![edit](../assets/edit.png)

Paste the contents of the bash script: [custom_login.sh](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh)
Paste the contents of the bash script: [custom_login.sh](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/custom_login.sh)

Below the shebang(`#!/bin/bash`) are the variables you need to change for the different themes.

Expand Down Expand Up @@ -84,7 +84,7 @@ Set `ADD_JS`to `"true"` to enable or `"false"` to omit the javascript.

***You should probably have a look at the content of that file, and probably host it yourself 💀***

[custom_text_header.js](https://github.com/gilbN/theme.park/blob/master/css/addons/unraid/login-page/retro-terminal/js/custom_text_header.js)
[custom_text_header.js](https://github.com/themepark-dev/theme.park/blob/master/css/addons/unraid/login-page/retro-terminal/js/custom_text_header.js)

⚠️⚠️⚠️

Expand Down
Loading

0 comments on commit 07899a2

Please sign in to comment.