Skip to content

docker.md

Latest commit

 

History

History
140 lines (103 loc) · 3.75 KB

docker.md

File metadata and controls

140 lines (103 loc) · 3.75 KB

Table of contents

Docker

This page list various operations that can be automated via Docker when developing cozy-stack.

For docker usage in production to self-host your cozy instance, please refer to our Self Hosting Documentation.

Running a CouchDB instance

This will run a new instance of CouchDB in single mode (no cluster). This command exposes couchdb on the port 5984.

$ docker run -d \
    --name cozy-stack-couch \
    -p 5984:5984 \
    -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password \
    -v $HOME/.cozy-stack-couch:/opt/couchdb/data \
    couchdb:3.3
$ curl -X PUT http://admin:password@127.0.0.1:5984/{_users,_replicator}

Verify your installation at: http://127.0.0.1:5984/_utils/#verifyinstall.

Note: for running some unit tests, you will need to use --net=host instead of -p 5984:5984 as we are using CouchDB replications and CouchDB will need to be able to open a connexion to the stack.

Building a cozy-stack via Docker

Warning, this command will build a linux binary. Use GOOS and GOARCH to adapt to your own system.

# From your cozy-stack developement folder
docker run -it --rm --name cozy-stack \
    --workdir /app \
    -v $(pwd):/app \
    -v $(pwd):/go/bin \
    golang:1.25 \
    go get -v github.com/cozy/cozy-stack

Publishing a new cozy-app-dev image

We publish the cozy-app-dev image when we release a new version of the stack. See scripts/docker/cozy-app-dev/release.sh for details.

Docker run and url name for cozy-app-dev

A precision for the app name:

docker run --rm -it -p 8080:8080 -v "$(pwd)/build":/data/cozy-app/***my-app*** cozy/cozy-app-dev

my-app will be the first part of: my-app.cozy.localhost:8080

Only-Office document server

Option 1: With Helper Script

Use the helper script that works on both Linux and macOS:

./scripts/start-oo.sh

The script automatically:

  • Collects all instance hostnames from cozy-stack
  • Starts OnlyOffice with proper --add-host mappings
  • Waits for OnlyOffice to be ready

Option 2: Manual Docker Command

For macOS and Linux (port mapping):

docker run -d --name onlyoffice-ds \
    -p 8000:80 \
    -e JWT_ENABLED=false \
    -e ALLOW_PRIVATE_IP_ADDRESS=true \
    -e ALLOW_META_IP_ADDRESS=true \
    --add-host=cozy.localhost:host-gateway \
    onlyoffice/documentserver:latest

For Linux only (--net=host):

docker run -d --name onlyoffice-ds \
    --net=host \
    -e JWT_ENABLED=false \
    -e ALLOW_PRIVATE_IP_ADDRESS=true \
    -e ALLOW_META_IP_ADDRESS=true \
    -e DS_PORT=8000 \
    onlyoffice/documentserver:latest

Configure cozy-stack

Add to your ~/.cozy/cozy.yaml:

contexts:
  default:
    onlyoffice_url: http://localhost:8000/

office:
  default:
    onlyoffice_url: http://localhost:8000/
    onlyoffice_inbox_secret: ""
    onlyoffice_outbox_secret: ""

Enable Feature Flag

cozy-stack features defaults '{"drive.office": {"enabled": true, "write": true}}'

Troubleshooting

OnlyOffice can't download the document:

  • Check OnlyOffice logs: docker logs onlyoffice-ds
  • Look for DNS errors like ENOTFOUND cozy.localhost
  • Ensure --add-host flag was applied: docker exec onlyoffice-ds cat /etc/hosts | grep cozy
  • Ensure ALLOW_PRIVATE_IP_ADDRESS=true is set

"Download failed" error in editor:

  • The Document Server can't reach cozy-stack
  • Verify connectivity: docker exec onlyoffice-ds wget -qO- http://cozy.localhost:8080/

No "Open with OnlyOffice" option in Drive:

  • Check feature flag: cozy-stack features show
  • Verify context has onlyoffice_url: check /settings/context endpoint