You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
109
-
```
109
+
110
+
```bash
110
111
docker run --rm --privileged multiarch/qemu-user-static:register --reset
111
112
```
112
113
113
114
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
114
115
115
-
## Update the chagelog
116
+
## Update the changelog
116
117
117
-
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-overseerr/tree/master/root), add an entry to the changelog
118
+
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-overseerr/tree/develop/root), add an entry to the changelog
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@
21
21
22
22
------------------------------
23
23
24
-
-[ ] I have read the [contributing](https://github.com/linuxserver/docker-overseerr/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
24
+
-[ ] I have read the [contributing](https://github.com/linuxserver/docker-overseerr/blob/develop/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
Copy file name to clipboardExpand all lines: .github/workflows/external_trigger.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ jobs:
18
18
fi
19
19
echo "**** External trigger running off of develop branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_OVERSEERR_DEVELOP\". ****"
Copy file name to clipboardExpand all lines: .github/workflows/greetings.yml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,6 @@ jobs:
8
8
steps:
9
9
- uses: actions/first-interaction@v1
10
10
with:
11
-
issue-message: 'Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-overseerr/blob/master/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-overseerr/blob/master/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!'
12
-
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-overseerr/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!'
11
+
issue-message: 'Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-overseerr/blob/develop/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-overseerr/blob/develop/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!'
12
+
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-overseerr/blob/develop/.github/PULL_REQUEST_TEMPLATE.md)!'
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library.
397
-
\" \
396
+
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library. \" \
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library.
425
-
\" \
423
+
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library. \" \
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library.
453
-
\" \
450
+
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library. \" \
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library.
488
-
\" \
484
+
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library. \" \
@@ -66,6 +66,10 @@ This image provides various versions that are available via tags. `latest` tag u
66
66
| latest | Stable releases from GitHub |
67
67
| develop | Development releases from commits in upstream develop branch |
68
68
69
+
## Application Setup
70
+
71
+
Access the webui at `<your-ip>:5055`, for more information check out [Overseerr](https://overseerr.dev/).
72
+
69
73
## Usage
70
74
71
75
Here are some example snippets to help you get started creating a container.
@@ -94,7 +98,7 @@ services:
94
98
95
99
### docker cli
96
100
97
-
```
101
+
```bash
98
102
docker run -d \
99
103
--name=overseerr \
100
104
-e PUID=1000 \
@@ -106,7 +110,6 @@ docker run -d \
106
110
ghcr.io/linuxserver/overseerr
107
111
```
108
112
109
-
110
113
## Parameters
111
114
112
115
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
@@ -125,7 +128,7 @@ You can set any environment variable from a file by using a special prepend `FIL
125
128
126
129
As an example:
127
130
128
-
```
131
+
```bash
129
132
-e FILE__PASSWORD=/run/secrets/mysecretpassword
130
133
```
131
134
@@ -144,24 +147,17 @@ Ensure any volume directories on the host are owned by the same user you specify
144
147
145
148
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
Access the webui at `<your-ip>:5055`, for more information check out [Overseerr](https://overseerr.dev/).
157
-
158
-
159
155
## Docker Mods
156
+
160
157
[](https://mods.linuxserver.io/?mod=overseerr"view available mods for this container.")[](https://mods.linuxserver.io/?mod=universal"view available universal mods.")
161
158
162
159
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
163
160
164
-
165
161
## Support Info
166
162
167
163
* Shell access whilst the container is running: `docker exec -it overseerr /bin/bash`
@@ -178,38 +174,45 @@ Most of our images are static, versioned, and require an image update and contai
178
174
Below are the instructions for updating containers:
179
175
180
176
### Via Docker Compose
177
+
181
178
* Update all images: `docker-compose pull`
182
179
* or update a single image: `docker-compose pull overseerr`
183
180
* Let compose update all containers as necessary: `docker-compose up -d`
184
181
* or update a single container: `docker-compose up -d overseerr`
185
182
* You can also remove the old dangling images: `docker image prune`
186
183
187
184
### Via Docker Run
185
+
188
186
* Update the image: `docker pull ghcr.io/linuxserver/overseerr`
189
187
* Stop the running container: `docker stop overseerr`
190
188
* Delete the container: `docker rm overseerr`
191
189
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
192
190
* You can also remove the old dangling images: `docker image prune`
193
191
194
192
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
193
+
195
194
* Pull the latest image at its tag and replace it with the same env variables in one run:
196
-
```
195
+
196
+
```bash
197
197
docker run --rm \
198
198
-v /var/run/docker.sock:/var/run/docker.sock \
199
199
containrrr/watchtower \
200
200
--run-once overseerr
201
201
```
202
+
202
203
* You can also remove the old dangling images: `docker image prune`
203
204
204
205
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
208
210
209
211
## Building locally
210
212
211
213
If you want to make local modifications to these images for development purposes or just to customize the logic:
0 commit comments