cryptpad/docs/cryptpad-docker.md

# Cryptpad Docker Image

Cryptpad includes support for building a Docker image and running it to provide a Cryptpad instance. You can manage the container manually, or let Docker Compose manage it for you.

A full tutorial is available [on the Cryptpad Github wiki](https://github.com/xwiki-labs/cryptpad/wiki/Docker). This document provides a brief overview.

## Features

- Configuration via .env file
- Ready for use with traffic
- Using github master for now, release 0.3.0 too old
- Creating customize folder
- Adding config.js to customize folder
- Persistance for datastore and customize folder

## Run

Run from the cryptpad source directory, keeping instance state in `/var/cryptpad`:

```
docker build -t xwiki/cryptpad .
docker run --restart=always -d --name cryptpad -p 3000:3000 -p 3001:3001 \
-v /var/cryptpad/files:/cryptpad/datastore \
-v /var/cryptpad/customize:/cryptpad/customize \
-v /var/cryptpad/blob:/cryptpad/blob \
-v /var/cryptpad/blobstage:/cryptpad/blobstage \
-v /var/cryptpad/pins:/cryptpad/pins \
-v /var/cryptpad/tasks:/cryptpad/tasks \
-v /var/cryptpad/block:/cryptpad/block \ 
xwiki/cryptpad
```

Or, using docker-compose and the included `docker-compose.yml`, keeping instance state in the current directory under `./data`:

```
docker-compose up -d
```

## Configuration

Set configurations Dockerfile or in .env (using docker-compose) file.

- VERSION=latest
- USE_SSL=false
- STORAGE='./storage/file'
- LOG_TO_STDOUT=true

The .env variables are read by docker-compose and forwarded to docker container.
On runtime, in `bin/container-start.sh` the settings are written to the `config.js` file.


## Persistance

The docker-compose file is preconfigured to persist folders

- cryptpad/datastore --> ./data/files
- cryptpad/customize --> ./data/customize
- cryptpad/pins --> ./data/pins
- cryptpad/blob --> ./data/blob
- cryptpad/blobstage --> ./data/blobstage
- cryptpad/tasks --> ./data/tasks
- cryptpad/block --> ./data/block

Your configuration file will be in `./data/customize/config.js`.

The data folder is ignored by git, so if you want to add your customizations to git versioning change the volume:

```
./customize:/cryptpad/customize:rw
```

## SSL Proxy

The [traefik](https://traefik.io/) proxy has builtin Let'sEncrypt for easy SSL setup.
In the docker-compose file you can find preset lables for usage with traefik.

[Traefik Docker Image](https://hub.docker.com/_/traefik/)

Alternativly just use plain old nginx.
adding docker and docker-compose 8 years ago			`# Cryptpad Docker Image`

Improve Docker documentation in the repo Now it will link to the wiki too. 6 years ago			`Cryptpad includes support for building a Docker image and running it to provide a Cryptpad instance. You can manage the container manually, or let Docker Compose manage it for you.`

Fix broken link in cryptpad-docker.md 5 years ago			`A full tutorial is available [on the Cryptpad Github wiki](https://github.com/xwiki-labs/cryptpad/wiki/Docker). This document provides a brief overview.`
Improve Docker documentation in the repo Now it will link to the wiki too. 6 years ago
			`## Features`

adding docker and docker-compose 8 years ago			`- Configuration via .env file`
			`- Ready for use with traffic`
			`- Using github master for now, release 0.3.0 too old`
			`- Creating customize folder`
			`- Adding config.js to customize folder`
			`- Persistance for datastore and customize folder`

Improve docker-related documentation - install/usage should be at the top, it's the most relevant info for typical users - docker call was missing `run` argument - added `--restart=always` to run it as a service - change default data directory. I think it's bad advice keeping data cluttered all over your file-system in some git repositories that one may want to delete later on 8 years ago			`## Run`

Improve Docker documentation in the repo Now it will link to the wiki too. 6 years ago			Run from the cryptpad source directory, keeping instance state in `/var/cryptpad`:
Improve docker-related documentation - install/usage should be at the top, it's the most relevant info for typical users - docker call was missing `run` argument - added `--restart=always` to run it as a service - change default data directory. I think it's bad advice keeping data cluttered all over your file-system in some git repositories that one may want to delete later on 8 years ago
			```
			`docker build -t xwiki/cryptpad .`
Add port 3001 to docker port mapping 6 years ago			`docker run --restart=always -d --name cryptpad -p 3000:3000 -p 3001:3001 \`
Improve Docker documentation in the repo Now it will link to the wiki too. 6 years ago			`-v /var/cryptpad/files:/cryptpad/datastore \`
cryptpad-docker: Missing \ 6 years ago			`-v /var/cryptpad/customize:/cryptpad/customize \`
Improve Docker documentation in the repo Now it will link to the wiki too. 6 years ago			`-v /var/cryptpad/blob:/cryptpad/blob \`
			`-v /var/cryptpad/blobstage:/cryptpad/blobstage \`
			`-v /var/cryptpad/pins:/cryptpad/pins \`
			`-v /var/cryptpad/tasks:/cryptpad/tasks \`
			`-v /var/cryptpad/block:/cryptpad/block \`
			`xwiki/cryptpad`
Improve docker-related documentation - install/usage should be at the top, it's the most relevant info for typical users - docker call was missing `run` argument - added `--restart=always` to run it as a service - change default data directory. I think it's bad advice keeping data cluttered all over your file-system in some git repositories that one may want to delete later on 8 years ago			```

Improve Docker documentation in the repo Now it will link to the wiki too. 6 years ago			Or, using docker-compose and the included `docker-compose.yml`, keeping instance state in the current directory under `./data`:
Improve docker-related documentation - install/usage should be at the top, it's the most relevant info for typical users - docker call was missing `run` argument - added `--restart=always` to run it as a service - change default data directory. I think it's bad advice keeping data cluttered all over your file-system in some git repositories that one may want to delete later on 8 years ago
			```
			`docker-compose up -d`
			```

adding docker and docker-compose 8 years ago			`## Configuration`

			`Set configurations Dockerfile or in .env (using docker-compose) file.`

			`- VERSION=latest`
			`- USE_SSL=false`
			`- STORAGE='./storage/file'`
			`- LOG_TO_STDOUT=true`

			`The .env variables are read by docker-compose and forwarded to docker container.`
			On runtime, in `bin/container-start.sh` the settings are written to the `config.js` file.


			`## Persistance`

			`The docker-compose file is preconfigured to persist folders`

Improve Docker documentation in the repo Now it will link to the wiki too. 6 years ago			`- cryptpad/datastore --> ./data/files`
adding docker and docker-compose 8 years ago			`- cryptpad/customize --> ./data/customize`
Improve Docker documentation in the repo Now it will link to the wiki too. 6 years ago			`- cryptpad/pins --> ./data/pins`
			`- cryptpad/blob --> ./data/blob`
			`- cryptpad/blobstage --> ./data/blobstage`
			`- cryptpad/tasks --> ./data/tasks`
			`- cryptpad/block --> ./data/block`
adding docker and docker-compose 8 years ago
Improve Docker documentation in the repo Now it will link to the wiki too. 6 years ago			Your configuration file will be in `./data/customize/config.js`.
adding docker and docker-compose 8 years ago
			`The data folder is ignored by git, so if you want to add your customizations to git versioning change the volume:`

			```
			`./customize:/cryptpad/customize:rw`
			```

			`## SSL Proxy`

			`The [traefik](https://traefik.io/) proxy has builtin Let'sEncrypt for easy SSL setup.`
			`In the docker-compose file you can find preset lables for usage with traefik.`

			`[Traefik Docker Image](https://hub.docker.com/_/traefik/)`

			`Alternativly just use plain old nginx.`