External/domain-watchdog
1
0
Fork 0
mirror of https://github.com/maelgangloff/domain-watchdog.git synced 2025-12-29 16:15:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Created Getting Started (markdown)

Maël Gangloff
2024-08-25 22:21:21 +02:00
parent 9aad65feb4
commit ef36f975eb
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Getting-Started.md Normal file

@@ -0,0 +1,19 @@
## Getting Started :rocket:
### Install with Docker
1. Clone the repository
2. Modify environment variables and add static files to customize your instance (see [INSTALL.md](https://github.com/maelgangloff/domain-watchdog/blob/master/INSTALL.md))
3. Pull the latest version of the Domain Watchdog image from Docker Hub.
```shell
docker compose pull
```
4. Start the project in production environment. If you want, you can also build the Docker image to use yourself.
```shell
docker compose up
```
By default, the container listens on http://localhost:8080/, but you can configure this in environment variables. See the [Docker Compose file](https://github.com/maelgangloff/domain-watchdog/blob/master/docker-compose.yml).
### Install from source
> [!NOTE]
> Please see [`INSTALL.md`](https://github.com/maelgangloff/domain-watchdog/blob/master/INSTALL.md) file