SinTan1729/chhoto-url
SinTan1729/chhoto-url
1
0
Fork 0
mirror of https://github.com/SinTan1729/chhoto-url synced 2024-10-16 13:27:03 -05:00
Code Issues Releases Activity

Make docker compose the recommended method of usage

Browse source
This commit is contained in:
Sayantan Santra 2022-11-05 14:41:00 -05:00
parent 99757dceb6
commit 0367e74a7c
1 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -47,12 +47,20 @@ whatever reason), you can message me through Github issues.
![Screenshot](./screenshot.png) ![Screenshot](./screenshot.png)
# Usage # 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 Clone this repository
``` ```
git clone https://gitlab.com/SinTan1729/simply-shorten git clone https://gitlab.com/SinTan1729/simply-shorten
``` ```
## Building from source Note that Gradle 6.x.x and JDK 11 are required. Other versions are not tested
Gradle 6.x.x and JDK 11 are required. Other versions are not tested
### 1. Build the `.jar` file ### 1. Build the `.jar` file
``` ```
gradle build --no-daemon gradle build --no-daemon
@ -101,13 +109,6 @@ docker run -p 4567:4567 \
-e db_url=/urls.sqlite \ -e db_url=/urls.sqlite \
-d simply-shorten:latest -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 ## Disable authentication
As requested in #5, it is possible to completely disable the authentication. As requested in #5, it is possible to completely disable the authentication.