Skip to content

Commit 8d2923b

Browse files
author
Rafael Bermudez Guijo
committed
docs: Added documentation for docker alternative
1 parent ae13692 commit 8d2923b

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,50 @@ This will create opapp.pkg in the project root directory. Edit the [XML AIT](htt
8080
Backend is deployable to any web server with PHP support. Make sure that the "servicelists" directory is writable. The backend stores new servicelists there.
8181

8282
NOTE: The frontend uses "example.xml" as the service list. It can be browsed in the Backend editor as well, but not modified. [https://dvb-i-reference.dvb.org/client/backend/servicelists/example.xml](https://dvb-i-reference.dvb.org/client/backend/servicelists/example.xml)
83+
84+
## Installation Alternative with Docker
85+
86+
For ease of deployment and development, you can utilize Docker to run the DVB-I Reference Application. This method allows you to quickly set up an environment without requiring manual configuration.
87+
88+
### Prerequisites
89+
90+
Before proceeding, ensure that you have the following installed on your system:
91+
- [Docker](https://docs.docker.com/get-docker/)
92+
- [Docker Compose](https://docs.docker.com/compose/install/)
93+
94+
### Steps for Docker Deployment
95+
96+
1. **Clone the Repository**:
97+
Begin by cloning the repository to your local machine.
98+
```bash
99+
git clone https://github.com/DVBProject/DVB-I-Reference-Client.git
100+
cd DVB-I-Reference-Client
101+
```
102+
103+
2. **Run Docker Containers**:
104+
Use the provided `docker-compose.yml` file to run the container.
105+
```bash
106+
docker-compose up -d
107+
```
108+
109+
3. **Access the Application**:
110+
Once the containers are up and running, you can access the DVB-I Reference Application by navigating to [http://localhost:8888/client](http://localhost:8888/client) in your web browser.
111+
112+
### Development Mode with Docker Volumes
113+
114+
If you prefer to work in a development mode, where changes to the source code are reflected immediately, you can use Docker volumes:
115+
116+
1. **Uncomment volume mapping at docker-compose.yml**:
117+
```yml
118+
volumes:
119+
- ./:/var/www/html/client
120+
```
121+
122+
2. **Run Docker Containers**:
123+
Use the modified `docker-compose.yml` file to run the container.
124+
```bash
125+
docker-compose up -d
126+
```
127+
128+
3. **Access the Application**:
129+
Continue to access the application via [http://localhost:8888/client](http://localhost:8888/client).

0 commit comments

Comments
 (0)