Skip to content

Commit 9cc2d93

Browse files
committed
Update getting-started.md
1 parent 0fd5276 commit 9cc2d93

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

docs/about/getting-started.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ nav_order: 2
66

77
# Getting started
88

9+
**Access via**: [http://localhost:36400](http://localhost:36400) (user = admin, password = admin)
10+
11+
To ensure the data is saved across builds, link an empty volume to: `/var/www/config` within the container. This is where the `env` file will be stored, along with the sqlite database and the application log files.
12+
13+
Note about websocket
14+
{: .label .label-purple }
15+
16+
**NOTE**: You will need to set the `REVERB_HOST` variable to the machine IP where **m3u editor** is runing for websockets to work correctly (if not running on `localhost`).
17+
18+
#### Table of contents
19+
20+
- [Docker compose (simplest)](#-docker-compose)
21+
- [Docker with internal Postgres (recommended)](#-docker-compose-with--sql-postgresql) <sup>(v0.6.0+)</sup>
22+
- [Docker with your Postgres (advanced)](#-if-youd-like-to-use-your-own-postgresql-instance) <sup>(v0.6.0+)</sup>
23+
24+
---
25+
926
## 🐳 Docker compose
1027

1128
Use the following compose example to get up and running.
@@ -40,15 +57,6 @@ Or via Docker CLI:
4057
docker run --name m3u-editor -e TZ=Etc/UTC -e APP_URL=http://localhost -e REVERB_HOST=localhost -e REVERB_SCHEME=http -v ./data:/var/www/config --restart unless-stopped -p 36400:36400 -p 36800:36800 sparkison/m3u-editor:latest
4158
```
4259

43-
Access via: [http://localhost:36400](http://localhost:36400) (user = admin, password = admin)
44-
45-
To ensure the data is saved across builds, link an empty volume to: `/var/www/config` within the container. This is where the `env` file will be stored, along with the sqlite database and the application log files.
46-
47-
Note about websocket
48-
{: .label .label-purple }
49-
50-
> You will need to set the `REVERB_HOST` variable to the machine IP where **m3u editor** is runing for websockets to work correctly, if not running on `localhost`.
51-
5260
---
5361

5462
## 🐳 Docker compose with 🐘 SQL (PostgreSQL)
@@ -110,7 +118,9 @@ PG_USER=m3ue
110118
PG_PASSWORD=secret
111119
```
112120
113-
### 🔧 If you'd like to use your own PostgreSQL instance
121+
---
122+
123+
## 🔧 If you'd like to use your own PostgreSQL instance
114124
{: .d-inline-block }
115125
116126
New (v0.6.0)

0 commit comments

Comments
 (0)