Skip to content

Commit e1369d2

Browse files
committed
Updated README
1 parent bde455f commit e1369d2

1 file changed

Lines changed: 54 additions & 2 deletions

File tree

README.md

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,54 @@
1-
# docker-mythweb
2-
Mythweb hosted in docker container
1+
# MythWeb Docker Image
2+
3+
This repository provides a Dockerized version of **MythWeb**, the classic web frontend for [MythTV](https://www.mythtv.org/).
4+
5+
Since MythWeb has been deprecated in recent MythTV releases and is no longer included in the v35+ ubuntu packages, this image helps continue hosting it in a convenient, containerized way.
6+
7+
> 🛠️ **Note:** You must have a working MythTV backend and accessible database for MythWeb to function.
8+
9+
---
10+
11+
## 🐳 Quick Start
12+
13+
### Environment Variables
14+
15+
The container requires the following environment variables:
16+
17+
| NAME | DESCRIPTION |
18+
|---|---|
19+
| db_server | IP / Hostname of the MySQL server |
20+
| db_name | Name of the MySQL daatabase (most likely 'mythconverg') |
21+
| db_login | MySQL database username |
22+
| db_password | MySQL database password |
23+
24+
### Running in Docker
25+
26+
To run the container manually with Docker:
27+
28+
```bash
29+
docker run --rm \
30+
-e db_server=<DB_SERVER_IP> \
31+
-e db_name=<DB_NAME> \
32+
-e db_login=<DB_USERNAME> \
33+
-e db_password=<DB_PASSWORD> \
34+
-p 8080:80 \
35+
adventuresintech/mythweb-docker:<version>
36+
```
37+
38+
### Running in Docker Compose
39+
```yaml
40+
version: '3.8'
41+
42+
services:
43+
mythweb:
44+
image: adventuresintech/mythweb-docker:<version>
45+
container_name: mythweb
46+
ports:
47+
- "8080:80"
48+
environment:
49+
db_server: <DB_SERVER_IP>
50+
db_name: <DB_NAME>
51+
db_login: <DB_USERNAME>
52+
db_password: <DB_PASSWORD>
53+
restart: unless-stopped
54+
```

0 commit comments

Comments
 (0)