How to install Cozy-stack?¶
- A reverse-proxy (nginx, caddy, haproxy, etc.)
- A SMTP server
- CouchDB 2
- Image Magick (and the Lato font)
To install CouchDB 2 through Docker, take a look at our Docker specific documentation.
Note: to generate thumbnails for heic/heif images, the version 7.0.7-22+ of Image Magick is required.
Install for self-hosting¶
We have started to write documentation on how to install cozy on your own server. We have a guide for debian. Don’t hesitate to report issues with it. It will help us improve it.
Install for development / local tests¶
Install the binary¶
You can either download the binary or compile it.
Download an official release¶
You can download a
cozy-stack binary from our official releases:
https://github.com/cozy/cozy-stack/releases. It is a just a single executable
file (choose the one for your platform). Rename it to cozy-stack, give it the
executable bit (
chmod +x cozy-stack) and put it in your
cozy-stack version should show you the version if every thing is right.
Install go, version >= 1.13. With
installed and configured, you can run the following command:
This will fetch the sources and build a binary in
Don’t forget to add your
$GOPATH/bin to your
$PATH in your
*rc file so
that you can execute the binary without entering its full path.
export PATH="$(go env GOPATH)/bin:$PATH"
Add an instance for testing¶
You can configure your
cozy-stack using a configuration file or different
comand line arguments. Assuming CouchDB is installed and running on default port
5984, you can start the server:
And then create an instance for development:
The cozy-stack server listens on http://cozy.localhost:8080/ by default. See
cozy-stack --help for more informations.
The above command will create an instance on http://cozy.localhost:8080/ with the
cozy. By default this will create a
storage/ entry in your current directory, containing all your instances by their URL. An instance “cozy.localhost:8080” will have its stored files in
storage/cozy.localhost:8080/. Installed apps will be found in the
.cozy_apps/ directory of each instance.
Make sure the full stack is up with:
curl -H 'Accept: application/json' 'http://cozy.localhost:8080/status/'
You can then remove your test instance:
cozy-stack instances rm cozy.localhost:8080