cells-enterprise install

./cells-enterprise install

Launch the installation process

Synopsis

This command launches the installation process of Pydio Cells.

Be ready to answer a few questions to configure the network connection of your application: 1. Bind URL: the name (or IP) and port to hook the internal webserver on a the network interface 2. TLS Settings: choose the TLS configuration that is exposed by this internal webserver 3. External URL: the URL you communicate to your end-users. It can differ from your bind address, typically if the app is behind a proxy or inside a container with ports mapping.

You can also provide these connection parameters via flags to configure the main gateway and directly launch the browser install. Typically, define only --bind and --external flags to launch in default self-signed mode: it generates locally trusted certificate with mkcert. If you are working locally, the installer opens a browser (if you are installing on a remote server, copy/paste the URL), to gather necessary extra information to finalize Pydio Cells installation.

Upon installation termination, all micro-services are started automatically and you can directly start using Cells. It is yet good practice to stop the installer and restart cells in normal mode before going live.

If you do not have a browser access, you can also perform the whole installation process using this CLI.

See additional flags for more details or use another TLS mode, like in the following example that uses Let's Encrypt automatic certificate generation.

$ ./cells-enterprise install --bind share.mydomain.tld:443 --external https://share.mydomain.tld --le_email admin@mydomain.tld --le_agree true

Here is a list with a few examples of valid URL couples:

./cells-enterprise install [flags]

Options

      --bind string            Internal URL:PORT on which the main proxy will bind. Self-signed SSL will be used by default
      --exit_after_install     Simply exits main process after the installation is done
      --external string        External PROTOCOL:URL:PORT exposed to the outside
  -h, --help                   help for install
      --json string            Points toward a configuration in JSON format
      --le_agree               Accept Let's Encrypt EULA
      --le_email string        Contact e-mail for Let's Encrypt provided certificate
      --le_staging             Rather use staging CA entry point
      --no_tls                 Configure the main gateway to rather use plain HTTP
      --tls_cert_file string   TLS cert file path
      --tls_key_file string    TLS key file path
      --yaml string            Points toward a configuration in YAML format

Options inherited from parent commands

      --broker string                     Pub/sub service for events between services (currently nats only) (default "nats")
      --broker_address string             Broker port (default ":4222")
      --enable_metrics                    Instrument code to expose internal metrics
      --enable_pprof                      Enable pprof remote debugging
      --fork                              Used internally by application when forking processes
      --grpc_cert string                  Certificates used for communication via grpc
      --grpc_external string              External port exposed for gRPC (may be fixed if no SSL is configured or a reverse proxy is used)
      --grpc_key string                   Certificates used for communication via grpc
      --log string                        Sets the log level mode (default "info")
      --registry string                   Registry used to manage services (currently nats only) (default "nats")
      --registry_address string           Registry connection address (default ":4222")
      --registry_cluster_address string   Registry cluster address (default ":5222")
      --registry_cluster_routes string    Registry cluster routes
      --transport string                  Transport protocol for RPC (default "grpc")
      --transport_address string          Transport protocol port (default ":4222")

SEE ALSO

Auto generated by Pydio Cells Enterprise Distribution v2.0.4 on 10-Mar-2020
Back to top