Skip to content

Commit

Permalink
Docker compose support (#54)
Browse files Browse the repository at this point in the history
* added docker-compose files

* updated readme with docker-compose instructions

* updated default docker-compose data folder
  • Loading branch information
LivingWithHippos authored Jan 1, 2021
1 parent ac0f0a7 commit 64914fb
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
LD_CONTAINER_NAME=linkding
LD_HOST_PORT=9090
LD_HOST_DATA_DIR=./data
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,22 @@ docker exec -it linkding python manage.py createsuperuser --username=joe --email
```
The command will prompt you for a secure password. After the command has completed you can start using the application by logging into the UI with your credentials.

### Docker-compose setup

To install linkding using docker-compose you can use the `docker-compose.yml` file. Rename the `.env.sample` file to `.env` and set you parameters, the run:
```shell
docker-compose up -d
```

### Docker-compose user setup

Finally you need to create a user so that you can access the frontend. Replace the credentials in the following command and run it:
```shell
docker-compose exec linkding python manage.py createsuperuser --username=joe --email=joe@example.com
```
The command will prompt you for a secure password. After the command has completed you can start using the application by logging into the UI with your credentials.


### Manual setup

If you can not or don't want to use Docker you can install the application manually on your server. To do so you can basically follow the steps from the *Development* section below while cross-referencing the `Dockerfile` and `bootstrap.sh` on how to make the application production-ready.
Expand Down
11 changes: 11 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: '3'

services:
linkding:
container_name: "${LD_CONTAINER_NAME:-linkding}"
image: sissbruecker/linkding:latest
ports:
- "${LD_HOST_PORT:-9090}:9090"
volumes:
- "${LD_HOST_DATA_DIR:-./data}:/etc/linkding/data"
restart: unless-stopped

0 comments on commit 64914fb

Please sign in to comment.