Install Pydio Cells

WARNING This documentation is for Cells v1. Looking for Pydio Cells v2 docs?

Once you have prepared your environment following one of the OS specific guide of the previous section, the installation process of Pydio Cells is self explanatory and straight forward. You can yet find more details and explanations in this section.

If you are installing the enterprise edition, you should first get your license key to be able to complete the installation.

Environment Variables

You can use the default settings or modify the following environment variables:

ENV content default
CELLS_WORKING_DIR the standard application directory
CELLS_DATA_DIR the default datasource CELLS_WORKING_DIR/data
CELLS_LOG_DIR the default logs location CELLS_WORKING_DIR/logs
CELLS_SERVICES_DIR location of services-specific data CELLS_WORKING_DIR/services

Launching the installer

First, give execution rights to the binary. For instance: sudo chmod u+x <binary>.

Then, to launch the installer:

  • [optional but recommended] switch to / log in as the specific user you have created to run Pydio Cells
  • go to the directory where your binary resides
  • simply type:
# Home edition
./cells install
# Enterprise edition
./cells-enterprise install

A first Installation mode menu appears in your terminal, choose if you want to use a browser or go on in the terminal to install Pydio Cells.

Then, define the url parameters of your instance:

  • Internal Url: internal url for Pydio Cells: the various services reaches each other through the gateway at this address. In most common cases, it is <ip>:<port>(example: If you are going to use SSL you should put your secure port 443 or else.
  • Choose SSL Activation mode:
    • Provide paths to certificate/key files: if you already have a certificate/key, you can use them.
    • Use Let's Encrypt: this option is based on the built-in caddy feature to create and manage certificate using the Let's Encrypt CA. Beware that if you use this option:
    • your DNS must be correctly configured and the your domain name should point to the correct IP.
    • the user that owns the cells process (and thus the underlying caddy server) must have sufficient permission on the .caddy/ configuration folder. Warning: if you launch the app with an invalid configuration, you might have your DNS temporary black listed on Let's encrypt due to failing multiple retries to get your certificate.
    • Generate a self-signed certificate: Pydio Cells generates a self signed certificate. Be advised this should not be used for system in production.
    • Provide paths to certificate/key files: if you already have a certificate/key, you can use them.
  • External Url: world facing URL of Pydio Cells. Usually, you can use the same URL as the bind URL. Thus this field is auto-filled with the value you have just entered and can be left untouched. In the case where you want to set up a more exotic configuration, adapt the URL here the external Url must always have the protocol such as for instance (or http). The external Url is your mean to access Cells therefore if you are running a reverse proxy this will in the mean case be like this , external_url = reverse_proxy_url used to access.

Subsequent steps are then pretty much the same in the browser or in the CLI.

Installation process

  1. [ED] Enterprise License key: put the license key here. Please refer to the Enterprise Edition Requirements guide to get one if necessary.
  2. Database connection: database connection parameters. DB user must have ALL PRIVILEGES granted on the corresponding database.
  3. Admin User: Cells' admin user information.
  4. Advanced Settings: you might change here the ports that are used internally by the various services when communication over the bind URL. Default used ports are non invasive, so you probably can skip this part.
  5. Apply Installation: you are done. A progress bar appears while the parameters are applied.
    • if you are using the web-based installer, the page reloads automatically when ready. Don't quit this page or press anything.
    • if you are using the CLI installer, you can stop and restart the app once you have seen the success message.

Next steps

To stop Pydio Cells, press CTRL + C in the terminal where you launched the installer.

You might start it again using this command to ensure everything work as expected:

# Home edition
./cells start
# Enterprise edition
./cells-enterprise start

Yet this is not the recommended way to start Pydio Cells when running in production. Please refer to the following chapter to finalize integration of your Cells instance with the host system.

If you encounter any issue during the installation process, please refer to the generic troubleshooting section of this guide or to the specific trouble shooting section that is at the bottom of each one of the OS specific installation guides.

In case you do not find any answer there, you should also have a look at our forum where our friendly community will be happy to help.

Back to top