Skip to content

Commit 4c51f92

Browse files
committed
Added timezone to dockerfile and use import in getting started docs
to dedupe docker content.
1 parent 49e5a60 commit 4c51f92

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ We provide a docker image with the full beeets-flask setup. You can run it with
5151

5252
**Using docker**
5353

54+
<!-- start setup container -->
5455
```sh
5556
docker run -d -p 5001:5001 \
5657
-e TZ=Europe/Berlin \
@@ -62,6 +63,7 @@ docker run -d -p 5001:5001 \
6263
--name beets-flask \
6364
pspitzner/beets-flask:stable
6465
```
66+
<!-- end setup container -->
6567

6668
**Using docker compose**
6769

docker/docker-compose.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ services:
55
ports:
66
- "5001:5001"
77
environment:
8+
# Change to your timezone
9+
TZ: "Europe/Berlin"
810
# 502 is default on macos, 1000 on linux
911
USER_ID: 1000
1012
GROUP_ID: 1000

docs/getting-started.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ cd beets-flask
1919
wget https://raw.githubusercontent.com/pspitzner/beets-flask/main/docker/docker-compose.yaml
2020
```
2121

22+
If you want to create it manually, you can use the following content:
23+
24+
```{literalinclude} ../docker/docker-compose.yaml
25+
```
26+
2227
3. Edit the docker-compose.yaml file! Please change the configuration and volume paths, otherwise the application might not start or work correctly. See the [configuration](configuration) section for more information.
2328

2429
4. Start the application using docker-compose.
@@ -29,19 +34,14 @@ docker-compose up
2934

3035
The application should now be available at `http://localhost:5001`!
3136

37+
3238
## Using docker
3339

3440
Similarly, you can also run the application using docker directly. Feel free to adjust the following command to your needs.
3541

36-
```bash
37-
docker run -d -p 5001:5001 \
38-
-e USER_ID=1000 \
39-
-e GROUP_ID=1000 \
40-
-v /wherever/config/:/config \
41-
-v /music_path/inbox/:/music_path/inbox/ \
42-
-v /music_path/clean/:/music_path/clean/ \
43-
--name beets-flask \
44-
pspitzner/beets-flask:stable
42+
```{include} ../README.md
43+
:start-after: <!-- start setup container -->
44+
:end-before: <!-- end setup container -->
4545
```
4646

4747
(configuration)=
@@ -51,7 +51,7 @@ docker run -d -p 5001:5001 \
5151
On first container launch, config files are automatically generated in the mounted `/config` folder. Configurations are read from `config/beets/config.yaml` and `config/beets-flask/config.yaml` (the latter takes precedence).
5252

5353
```{warning}
54-
Configuration changes are only applied on container restart. Restat your container with `docker restart beets-flask` after changing a configuration
54+
Configuration changes are only applied on container restart. Restart your container with `docker restart beets-flask` after changing a configuration
5555
option.
5656
```
5757

0 commit comments

Comments
 (0)