Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ReadMe Updated and Docker-compose added #115

Open
wants to merge 3 commits into
base: 4.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 42 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ https://user-images.githubusercontent.com/59018146/167635903-48cdace0-c383-4e7d-

#### Current stable branch `4.x`

### Live demo at [ddrive.forscht.dev](https://ddrive.forscht.dev/)

### Features
- Theoretically unlimited file size, thanks to splitting the file in 24mb chunks using nodejs streams API.
- Simple yet robust HTTP front end
Expand Down Expand Up @@ -111,15 +109,49 @@ PUBLIC_ACCESS=READ_ONLY_FILE # If you want to give read only access to panel or
UPLOAD_CONCURRENCY=3 # ddrive will upload this many chunks in parallel to discord. If you have fast internet increasing it will significantly increase performance at cost of cpu/disk usage

```
### Run using Docker
```shell
docker run -rm -it -p 8080:8080 \
-e PORT=8080 \
-e WEBHOOKS={url1},{url2} \
-e DATABASE_URL={database url} \
--name ddrive forscht/ddrive
```

### Run using Docker Compose

Create a `docker-compose.yml` file with the following content:

```yaml
version: '3.8'

services:
ddrive:
image: forscht/ddrive
container_name: ddrive
ports:
- "8080:8080"
environment:
- DATABASE_URL={database url}
- WEBHOOKS={url1},{url2}
- PORT=3000
- REQUEST_TIMEOUT=60000
- CHUNK_SIZE=25165824
- SECRET=someverysecuresecret
- AUTH=admin:admin
- PUBLIC_ACCESS=READ_ONLY_FILE
- UPLOAD_CONCURRENCY=3
stdin_open: true
tty: true
restart: always
```

Then, run the following command to start the service:

```sh
docker-compose up
```

### Run using docker
```shell
docker run -rm -it -p 8080:8080 \
-e PORT=8080 \
-e WEBHOOKS={url1},{url2} \
-e DATABASE_URL={database url} \
--name ddrive forscht/ddrive
```
### One Click Deploy with Railway
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/tL53xa)

Expand Down
21 changes: 21 additions & 0 deletions docker.compose.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
version: '3.8'

services:
ddrive:
image: forscht/ddrive
container_name: ddrive
ports:
- "8080:8080"
environment:
- DATABASE_URL={database url}
- WEBHOOKS={url1},{url2}
- PORT=8080
- REQUEST_TIMEOUT=60000
- CHUNK_SIZE=25165824
- SECRET=someverysecuresecret
- AUTH=admin:admin
- PUBLIC_ACCESS=READ_ONLY_FILE
- UPLOAD_CONCURRENCY=3
stdin_open: true
tty: true
restart: always
Loading