From 0b89ccb69939f2acd699e517a2749aecae4a188a Mon Sep 17 00:00:00 2001 From: Austin Best Date: Tue, 12 Nov 2024 21:40:13 -0500 Subject: [PATCH] Cleanup the readme a little bit --- README.md | 51 +++++++++++++++++++----- root/app/www/public/functions/logger.php | 2 +- 2 files changed, 41 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5e1a229..6abfe09 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,23 @@ -![Logo](root/app/www/public/images/logo-64.png) +

+ Starr Proxy
+ Starr Proxy +

-# Starr Proxy +## Note -## Note! +This is still being tested and generating templates. Feel free to join the Notifiarr discord and ask questions in the `#starrproxy` channel or help out with templates -This is still very much in development (mainly the templates) and being tested. Feel free to join the Notifiarr discord and ask questions in the `#starrproxy` channel +## Navigation + +- [Purpose](#purpose) +- [Templates](#app-templates) + - [Current templates](#current-templates) +- [Automation](#automation) +- [Installation](#installation) + - [Compose example](#compose-example) + - [Run example](#run-example) + - [Environment variables](#environment-variables) +- [Screenshots](#screenshots) ## Purpose @@ -16,7 +29,21 @@ Access logs per app are generated so you can see everytime the app hits the prox ## App templates -There are some pre-built templates than enable just the api access the app actually needs so they are quick and easy to setup. More will be added in time for the common 3rd party apps. +There are some pre-built templates that enable just the api access the app actually needs so they are quick and easy to setup. More will be added in time for the common 3rd party apps. + +### Current templates + +- Autobrr +- Bazarr +- DAPS +- Jellyseerr +- Kometa +- Nabarr +- Notifiarr +- Omegabrr +- Overseerr +- Recyclarr +- Unpackerr ## Automation @@ -80,7 +107,9 @@ Errors: } ``` -## Compose example +## Installation + +### Compose example ``` yaml services: @@ -97,7 +126,7 @@ services: ``` -## Run example +### Run example ``` bash docker run \ @@ -112,17 +141,17 @@ docker run \ "ghcr.io/notifiarr/starrproxy:main" ``` -## Environment +### Environment variables -### Volumes +#### Volumes Name: `App config`, Host: `/volume1/data/docker/starrproxy/config`, Container: `/config` -### Ports +#### Ports Inside: `80`, Outside: `9999` -### Variables +#### Variables Name: `TZ`, Key: `TZ`, Value: `America/New_York` diff --git a/root/app/www/public/functions/logger.php b/root/app/www/public/functions/logger.php index e9cbece..bae8570 100644 --- a/root/app/www/public/functions/logger.php +++ b/root/app/www/public/functions/logger.php @@ -67,7 +67,7 @@ function getLogs() if (str_contains($log, '.log')) { $logfile = str_replace('.log', '', $log); list($access, $app, $date) = explode('_', $logfile); - + if ($app && !is_numeric($app)) { $list[$app][$logfile] = $folder . $logfile . '.log'; ksort($list[$app]);