Documentation looks uncomplete

Open
#141 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
docker

Research direction

Search the documentation for the existing Docker Hub or container setup section, then compare it with the example command and warning shown in the issue. Document the required config.js mount, data volumes, ports, and any other setup prerequisites. Done means a newcomer can run the prebuilt image with persistent storage using the documented instructions.

Written by the indexing model from the issue text.

Description

admin guide

The documentation mentions the image being available on Docker Hub,

but there is basically no documentation on the setup using the prebuld image (such as volumes, if any?).

currently i have this

IMAGE="docker.io/cryptpad/cryptpadlatest"
CONT_NAME="cryptpad"
root_conf_path="[...]/cryptpad/"
touch  $root_conf_path/config.js

podman run \
  --name $CONT_NAME \
  --detach \
  --restart always \
  -p 3000:3000 \
  -p 3003:3003 \
  -v "$root_conf_path/config.js:/cryptpad/config/config.js" \
  -v "$root_conf_path/data/blob:/cryptpad/blob" \
  -v "$root_conf_path/data/block:/cryptpad/block" \
  -v "$root_conf_path/data/data:/cryptpad/data" \
  -v "$root_conf_path/data/files:/cryptpad/datastore" \
  -v "$root_conf_path/customize:/cryptpad/customize" \
  -v "$root_conf_path/onlyoffice-dist:/cryptpad/www/common/onlyoffice/dist" \
  -v "$root_conf_path/onlyoffice-conf:/cryptpad/onlyoffice-conf" \
  "$IMAGE"
cp: can't create '': No such file or directory

         #################################################################### 
         Warning: No config file provided for cryptpad 
         We will create a basic one for now but you should rerun this service 
         by providing a file with your settings 
         eg: docker run -v /path/to/config.js:/cryptpad/config/config.js 
         #################################################################### 
Dominant language
HTML
Stars
39
Forks
22
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cryptpad/documentation

All issues in cryptpad/documentation

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.