aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeif G. <46281254+4ctiv@users.noreply.github.com>2024-08-12 17:06:05 +0200
committerGitHub <noreply@github.com>2024-08-12 18:06:05 +0300
commit097cf610e664c922c1c618b11a582bb6a1d959f8 (patch)
tree1ffa826a227b05a43b4fc46972bf272fbe76ac3e
parent7ee893a287c8992196b0b5f51124074fa7c47f4f (diff)
Add docker-compose (further simplify docker setup) (#55)
* Add docker-compose.yml Add docker compose to further simplify the setup of the docker project. This eliminates the need to specify the need for defining ports and volumes in the command and moves it to the docker-compose file instead. * Update README.md Add docker-compose command to documentation * Update README.md (docker instructions) Update md formating for docker commands (this enables one-click-copy in the github preview)
-rw-r--r--README.md15
-rw-r--r--docker-compose.yml11
2 files changed, 23 insertions, 3 deletions
diff --git a/README.md b/README.md
index 578a5c9..1976d39 100644
--- a/README.md
+++ b/README.md
@@ -28,9 +28,18 @@ Default channel example: https://synctube.onrender.com/
- Open showed "Local" link for yourself and send "Global" link to friends
### Setup (Docker)
-- As alternative, you can install Docker and run:
-- `docker build -t synctube .`
-- `docker run --rm -it -p 4200:4200 -v ${PWD}/user:/usr/src/app/user synctube`
+As alternative, you can install Docker and run:
+> ```shell
+> docker build -t synctube .
+> docker run --rm -it -p 4200:4200 -v ${PWD}/user:/usr/src/app/user synctube
+> ```
+
+or
+
+> ```shell
+> docker compose up -d
+> ```
+
- (Docker container hides real local/global ips, so you need to checkout it manually)
### Configuration
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 0000000..47945f4
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,11 @@
+# Run this as follows: 'docker compose up' (keep running in terminal session, exist via [STRG] + [C])
+# or 'docker compose up -d' (keep running in background)
+version: "3"
+services:
+ synctube:
+ build: .
+ #image: synctube
+ ports:
+ - "4200:4200"
+ volumes:
+ - "${PWD}/user:/usr/src/app/user"
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage