Documentation looks uncomplete
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
- Domain
- devops, documentation
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
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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cryptpad/documentation
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
cryptpad/documentation#159 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
cryptpad/documentation#157 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
cryptpad/documentation#155 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
cryptpad/documentation#154 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
cryptpad/documentation#152 ·
All issues in cryptpad/documentation
Similar issues
-
kind/bug needs-triage
Difficulty 1/5 Under an hour Newbie friendliness 72/100
matrixorigin/matrixone#29223 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
copse-dev/agent-pane#2953 ·
-
bug ci-failure high priority
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
vllm-project/vllm-omni#7972 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
bug good first issue
Difficulty 1/5 Under an hour Newbie friendliness 88/100
amponce/archive-movie-browser#166 ·