Skip to content

Commit 69c3b09

Browse files
guillevcguillevc
committed
docs: simplify README and sample compose files
1 parent c271049 commit 69c3b09

3 files changed

Lines changed: 64 additions & 122 deletions

File tree

‎README.md‎

Lines changed: 55 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,20 @@
1111
**Request movies & shows in Jellyseerr/Overseerr from your favorite lists**
1212

1313
[![CI](https://github.com/guillevc/listseerr/actions/workflows/ci.yaml/badge.svg)](https://github.com/guillevc/listseerr/actions/workflows/ci.yaml)
14-
[![GitHub Release](https://img.shields.io/github/v/release/guillevc/listseerr?include_prereleases)](https://github.com/guillevc/listseerr/releases)
15-
[![Docker](https://img.shields.io/badge/Docker-GHCR-2496ED?logo=docker&logoColor=white)](https://ghcr.io/guillevc/listseerr)
16-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
14+
[![GitHub Release](https://img.shields.io/github/v/release/guillevc/listseerr)](https://github.com/guillevc/listseerr/releases)
15+
[![Docker Image](https://img.shields.io/badge/ghcr.io-blue?logo=docker&logoColor=white)](https://ghcr.io/guillevc/listseerr)
16+
[![Ko-fi](https://img.shields.io/badge/Ko--fi-F16061?logo=ko-fi&logoColor=white)](https://ko-fi.com/guillevc)
17+
18+
<p>
19+
<a href="docs/screenshots/dashboard.png"><img src="docs/screenshots/dashboard.png" width="40%"></a>
20+
<a href="docs/screenshots/lists.png"><img src="docs/screenshots/lists.png" width="40%"></a>
21+
</p>
22+
23+
[See more screenshots →](docs/screenshots)
1724

1825
</div>
1926

20-
## How It Works
27+
## 🧩 How It Works
2128

2229
```
2330
┌──────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐
@@ -39,141 +46,67 @@
3946

4047
Listseerr skips media that was previously rejected or is already available, so you won't see duplicate requests. Set it up once and let it run on a schedule.
4148

42-
## Screenshots
43-
44-
<p>
45-
<a href="docs/screenshots/dashboard.png"><img src="docs/screenshots/dashboard.png" width="32%"></a>
46-
<a href="docs/screenshots/lists.png"><img src="docs/screenshots/lists.png" width="32%"></a>
47-
<a href="docs/screenshots/settings.png"><img src="docs/screenshots/settings.png" width="32%"></a>
48-
</p>
49-
50-
[See more →](docs/screenshots)
49+
## 🚀 Quick Start
5150

52-
## Supported Providers
53-
54-
| Provider | Status | Requirements |
55-
| ----------------------- | ------------ | --------------------------------------------------- |
56-
| **Trakt** | ✅ Supported | [Free API key](https://trakt.tv/oauth/applications) |
57-
| **MDBList** | ✅ Supported | [Free API key](https://mdblist.com/preferences/) |
58-
| **StevenLu** | ✅ Supported | None |
59-
| **StevenLu variations** | 🗓️ Planned | None |
60-
| **IMDB** | 🗓️ Planned | — |
61-
| **Letterboxd** | 🗓️ Planned | — |
62-
| **TheMovieDB** | 🗓️ Planned | — |
63-
64-
Listseerr uses official APIs for reliable integration and faster processing.
65-
66-
**Want another provider?** [Request or vote here](https://github.com/guillevc/listseerr/discussions/1)
67-
68-
## Quick Start
69-
70-
> [!TIP]
71-
> Download the config files directly:
72-
>
73-
> ```bash
74-
> mkdir listseerr && cd listseerr
75-
>
76-
> # Download config files
77-
> wget https://raw.githubusercontent.com/guillevc/listseerr/master/deploy/compose.yaml
78-
> wget https://raw.githubusercontent.com/guillevc/listseerr/master/deploy/.env.example -O .env
79-
>
80-
> # Edit .env and set ENCRYPTION_KEY (generate with: openssl rand -hex 32)
81-
>
82-
> docker compose up -d
83-
> ```
84-
>
85-
> Open http://localhost:3000 and start adding lists.
86-
87-
### 1. Create `compose.yaml`
51+
### 1. Create a `compose.yaml`
8852

8953
```yaml
9054
services:
9155
listseerr:
9256
image: ghcr.io/guillevc/listseerr:latest
9357
container_name: listseerr
94-
user: ${PUID:-1000}:${PGID:-1000}
9558
ports:
96-
- 3000:${PORT:-3000}
97-
env_file:
98-
- .env
59+
- 3000:3000
60+
environment:
61+
TZ: 'UTC'
62+
# (REQUIRED) Generate with: openssl rand -hex 32
63+
ENCRYPTION_KEY: ''
9964
volumes:
10065
- ./data:/app/data
10166
restart: unless-stopped
10267
```
10368
104-
### 2. Create `.env`
105-
106-
```properties
107-
PUID=1000
108-
PGID=1000
69+
Remember to include the `ENCRYPTION_KEY` environment variable, which has no default value.
10970

110-
PORT=3000
111-
LOG_LEVEL=info
112-
113-
# Timezone in IANA format (e.g. Europe/Madrid). Defaults to UTC.
114-
TZ=UTC
115-
116-
# (REQUIRED) Generate with: openssl rand -hex 32
117-
ENCRYPTION_KEY=
118-
```
119-
120-
### 3. Start Listseerr
71+
### 2. Run the container
12172

12273
```bash
12374
docker compose up -d
12475
```
12576

126-
Open [http://localhost:3000](http://localhost:3000) and start adding lists.
127-
128-
## Configuration
77+
### 3. Start adding lists
12978

130-
| Variable | Description | Docker | Local build |
131-
| ---------------- | -------------------------------------------------------------------------------------- | ------------------------ | --------------------- |
132-
| `ENCRYPTION_KEY` | **Required.** Generate with `openssl rand -hex 32` | — | — |
133-
| `PORT` | Server port | `3000` | `3000` |
134-
| `DATABASE_PATH` | Path to SQLite database | `/app/data/listseerr.db` | `./data/listseerr.db` |
135-
| `LOG_LEVEL` | Logging level (`debug`, `info`, `warn`, `error`) | `info` | `debug` |
136-
| `TZ` | Timezone ([IANA format](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)) | `UTC` | System |
137-
| `PUID` / `PGID` | User/Group ID for Docker volumes | `1000` | N/A |
79+
Open [http://localhost:3000](http://localhost:3000) and create your account.
13880

139-
Override defaults via `.env` file or Docker environment variables.
81+
## ⚙️ Configuration
14082

141-
## Development
83+
| Variable | Description | Default (Docker) |
84+
| ---------------- | -------------------------------------------------- | ------------------------ |
85+
| `ENCRYPTION_KEY` | **Required.** Generate with `openssl rand -hex 32` | — |
86+
| `PORT` | Server port | `3000` |
87+
| `DATABASE_PATH` | Path to SQLite database | `/app/data/listseerr.db` |
88+
| `LOG_LEVEL` | Logging level (`debug`, `info`, `warn`, `error`) | `info` |
89+
| `TZ` | Timezone (IANA format) | `UTC` |
14290

143-
<details>
144-
<summary><strong>Dev server </strong></summary>
145-
**Prerequisites:** [Bun](https://bun.sh) (version in `.bun-version`)
146-
> [mise](https://mise.jdx.dev/) users can run `mise install` to set up Bun automatically.
147-
148-
```bash
149-
git clone https://github.com/guillevc/listseerr.git
150-
cd listseerr
151-
bun install
152-
153-
cp .env.example .env
154-
# Edit .env and set ENCRYPTION_KEY
155-
156-
# Run both server and client
157-
bun run dev
158-
```
91+
Override defaults via Docker environment variables.
15992

160-
</details>
93+
## 🔗 Supported Providers
16194

162-
<details>
163-
<summary><strong>Local docker build</strong></summary>
164-
165-
```bash
166-
docker build -t listseerr .
167-
168-
cp deploy/.env.example .env.docker
169-
# Edit .env.docker
95+
| Provider | Status | Requirements |
96+
| ----------------------- | ------------ | --------------------------------------------------- |
97+
| **Trakt** | ✅ Supported | [Free API key](https://trakt.tv/oauth/applications) |
98+
| **MDBList** | ✅ Supported | [Free API key](https://mdblist.com/preferences/) |
99+
| **StevenLu** | ✅ Supported | None |
100+
| **StevenLu variations** | 🗓️ Planned | None |
101+
| **IMDB** | 🗓️ Planned | — |
102+
| **Letterboxd** | 🗓️ Planned | — |
103+
| **TheMovieDB** | 🗓️ Planned | — |
170104

171-
docker compose up -d
172-
```
105+
Listseerr uses official APIs for reliable integration and faster processing.
173106

174-
</details>
107+
**Want another provider?** [Request or vote here](https://github.com/guillevc/listseerr/discussions/1)
175108

176-
## Password Recovery
109+
## 🔑 Password Recovery
177110

178111
**Docker:**
179112

@@ -187,7 +120,7 @@ docker exec -it listseerr bun /app/dist/reset-password.js
187120
bun run password:reset
188121
```
189122

190-
## Roadmap
123+
## 🗺️ Roadmap
191124

192125
- [x] Multiple provider support (Trakt, MDBList, StevenLu)
193126
- [x] Scheduled automatic processing
@@ -198,10 +131,17 @@ bun run password:reset
198131

199132
Have an idea? [Open an issue](https://github.com/guillevc/listseerr/issues/new)
200133

201-
## Acknowledgments
134+
## 💜 Support
135+
136+
If Listseerr is useful to you, consider supporting its development:
137+
138+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/guillevc)
139+
140+
## 🤝 Acknowledgments
202141

203-
Color scheme: [Flexoki](https://stephango.com/flexoki) by Steph Ango
142+
- Color scheme: [Flexoki](https://stephango.com/flexoki) by Steph Ango
143+
- Inspired by the amazing self-hosted community
204144

205-
## License
145+
## 📄 License
206146

207147
[MIT](LICENSE)

‎deploy/.env.example‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
## Listseerr docker deployment
22

3-
PUID=1000
4-
PGID=1000
5-
3+
# Server
64
PORT=3000
75
LOG_LEVEL=info
86

‎deploy/compose.yaml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,15 @@ services:
44
listseerr:
55
image: ghcr.io/guillevc/listseerr:latest
66
container_name: listseerr
7-
user: ${PUID:-1000}:${PGID:-1000}
87
ports:
9-
- 3000:${PORT:-3000}
10-
env_file:
11-
- .env
8+
- 3000:${PORT}
9+
environment:
10+
PORT: ${PORT}
11+
LOG_LEVEL: ${LOG_LEVEL}
12+
TZ: ${TZ}
13+
# (REQUIRED) Used for database encryption of API keys
14+
# Generate with: openssl rand -hex 32
15+
ENCRYPTION_KEY: ${ENCRYPTION_KEY}
1216
volumes:
1317
- ./data:/app/data
1418
restart: unless-stopped

0 commit comments

Comments
 (0)