From 69aa7cfcb2eeebb9a67ac8111e8f66e9938bf893 Mon Sep 17 00:00:00 2001 From: Filipe Carneiro Date: Thu, 7 Mar 2024 17:33:15 +0000 Subject: [PATCH] doc: deployment instructions --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2fa9962..ff32baa 100644 --- a/README.md +++ b/README.md @@ -88,28 +88,37 @@ To build the Open E-Label project using Visual Studio, follow these steps: The web app can be deployed using the [published Docker image](https://hub.docker.com/r/fcarneiro/elabel). Here are the steps to run it with Docker compose: -1 Copy `docker-compose.yml` to your server. Change server details as needed: +1 Create a new directory and download `docker-compose.yml` sample: ```shell -scp docker-compose.yml user@server:~/elabel/ +mkdir elabel && cd elabel +wget https://raw.githubusercontent.com/filipecarneiro/ELabel/main/docker-compose.yml ``` -2 Start containers on server: +2 Write your passwords to an .env file (change to your own passwords!): ```shell -ssh user@server +echo "MSSQL_SA_PASSWORD=MyStrongPassword" >> .env +echo "ADMIN_PASSWORD=MyAdminPassword" >> .env +``` + +3 Start all containers: -cd elabel/ +```shell docker-compose pull docker-compose up -d ``` -3 View Logs: +4 View Logs: ```shell docker-compose logs -f ``` +`db` will take some time in the first start, so the app will restart a couple of times. Be patient! + +When you see something like `Now listening on: http://[::]:8080` on the log, open your browser with the server name or IP address. + ## 🙋 Contributing Contributions are welcome! Please read our [contributing guidelines](CONTRIBUTING.md) before getting started.