From 0367e74a7c2c07eea68c4dd97143050c4c24f24d Mon Sep 17 00:00:00 2001 From: SinTan1729 Date: Sat, 5 Nov 2022 14:41:00 -0500 Subject: [PATCH] Make docker compose the recommended method of usage --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fe67bbb..191ef70 100644 --- a/README.md +++ b/README.md @@ -47,12 +47,20 @@ whatever reason), you can message me through Github issues. ![Screenshot](./screenshot.png) # Usage +## Using `docker compose` (Recommended method) +There is a sample `docker-compose.yml` file in this repository. It contains +everything needed for a basic install. You can use it as a base, modifying +it as needed. Run it with +``` +docker compose up -d +``` + +## Building from source Clone this repository ``` git clone https://gitlab.com/SinTan1729/simply-shorten ``` -## Building from source -Gradle 6.x.x and JDK 11 are required. Other versions are not tested +Note that Gradle 6.x.x and JDK 11 are required. Other versions are not tested ### 1. Build the `.jar` file ``` gradle build --no-daemon @@ -101,13 +109,6 @@ docker run -p 4567:4567 \ -e db_url=/urls.sqlite \ -d simply-shorten:latest ``` -## `docker-compose` -There is a sample `docker-compose.yml` file in this repository. It contains -everything needed for a basic install. You can use it as a base, modifying -it as needed. Run it with -``` -docker-compose up -d -``` ## Disable authentication As requested in #5, it is possible to completely disable the authentication.