Skip to content

Commit f23c020

Browse files
committed
chore(docs): README update
1 parent 419d523 commit f23c020

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
</ul>
2525
</div>
2626

27+
> [!WARNING]
28+
> ⚠️ This is very much still work in progress! There are no safety measures in place, DO NOT expose the app to the internet, place it behind IAM apps like Authelia/Authentik/KeyCloak etc or limit strictly to internal/vpn network use!
29+
>
30+
2731
## 📝 Table of Contents
2832

2933
1. [Preview](#preview)
@@ -61,11 +65,10 @@ Support for indexers is basic so far due to PoC-level, more to come:
6165
* *generic UNIT3D-based indexer*
6266

6367
## <a name="installation"></a> 🖥️ Getting started
64-
!!! Currently no stable release (soon), it can be run from development docker command below.
6568

6669
### Requirements
6770
* docker
68-
* a running and accessible Prowlarr instance
71+
* a running and accessible [Prowlarr](https://prowlarr.com) instance
6972
* (optional) [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) instance (not included by default in base `compose.yml`)
7073

7174
Copy `.env.template` to `.env`, fill up the required envs and run:
@@ -74,6 +77,8 @@ Copy `.env.template` to `.env`, fill up the required envs and run:
7477
docker compose up -d
7578
```
7679

80+
As a minimum security the app runs as non-root user `1000:1000`.
81+
7782
## <a name="development"></a> 🪚 Development
7883

7984
### Frontend

0 commit comments

Comments
 (0)