From ef36f975ebe396bafd7004c38b3fca68de4576ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABl=20Gangloff?= Date: Sun, 25 Aug 2024 22:21:21 +0200 Subject: [PATCH] Created Getting Started (markdown) --- Getting-Started.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 Getting-Started.md diff --git a/Getting-Started.md b/Getting-Started.md new file mode 100644 index 0000000..cc8b329 --- /dev/null +++ b/Getting-Started.md @@ -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 \ No newline at end of file