github.com/cozy/cozy-stack@v0.0.0-20240603063001-31110fa4cae1/docs/cli/cozy-stack_serve.md (about)

     1  ## cozy-stack serve
     2  
     3  Starts the stack and listens for HTTP calls
     4  
     5  ### Synopsis
     6  
     7  Starts the stack and listens for HTTP calls
     8  It will accept HTTP requests on localhost:8080 by default.
     9  Use the --port and --host flags to change the listening option.
    10  
    11  The SIGINT signal will trigger a graceful stop of cozy-stack: it will wait that
    12  current HTTP requests and jobs are finished (in a limit of 2 minutes) before
    13  exiting.
    14  
    15  If you are the developer of a client-side app, you can use --appdir
    16  to mount a directory as the application with the 'app' slug.
    17  
    18  
    19  ```
    20  cozy-stack serve [flags]
    21  ```
    22  
    23  ### Examples
    24  
    25  ```
    26  The most often, this command is used in its simple form:
    27  
    28  	$ cozy-stack serve
    29  
    30  But if you want to develop two apps in local (to test their interactions for
    31  example), you can use the --appdir flag like this:
    32  
    33  	$ cozy-stack serve --appdir appone:/path/to/app_one,apptwo:/path/to/app_two
    34  
    35  ```
    36  
    37  ### Options
    38  
    39  ```
    40        --allow-root                                          Allow to start as root (disabled by default)
    41        --appdir strings                                      Mount a directory as the 'app' application
    42        --assets string                                       path to the directory with the assets (use the packed assets by default)
    43        --couchdb-url string                                  CouchDB URL (default "http://localhost:5984/")
    44        --csp-allowlist string                                Add domains for the default allowed origins of the Content Secury Policy
    45        --dev                                                 Allow to run in dev mode for a prod release (disabled by default)
    46        --disable-csp                                         Disable the Content Security Policy (only available for development)
    47        --doctypes string                                     path to the directory with the doctypes (for developing/testing a remote doctype)
    48        --downloads-url string                                URL for the download secret storage, redis or in-memory
    49        --flagship-apk-certificate-digests strings            SHA-256 hash (base64 encoded) of the flagship app's signing certificate on android (default [u2eUUnfB4Y7k7eqQL7u2jiYDJeVBwZoSV3PZSs8pttc=])
    50        --flagship-apk-package-names strings                  Package name for the flagship app on android (default [io.cozy.drive.mobile,io.cozy.flagship.mobile])
    51        --flagship-apple-app-ids strings                      App ID of the flagship app on iOS (default [3AKXFMV43J.io.cozy.drive.mobile,3AKXFMV43J.io.cozy.flagship.mobile])
    52        --flagship-play-integrity-decryption-keys strings     Decryption key for the Google Play Integrity API (default [bVcBAv0eO64NKIvDoRHpnTOZVxAkhMuFwRHrTEMr23U=])
    53        --flagship-play-integrity-verification-keys strings   Verification key for the Google Play Integrity API (default [MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAElTF2uARN7oxfoDWyERYMe6QutI2NqS+CAtVmsPDIRjBBxF96fYojFVXRRsMb86PjkE21Ol+sO1YuspY+YuDRMw==])
    54        --fs-default-layout int                               Default layout for Swift (2 for layout v3) (default -1)
    55        --fs-url string                                       filesystem url (default "file:///home/runner/work/cozy-stack/cozy-stack/storage")
    56        --geodb string                                        define the location of the database for IP -> City lookups (default ".")
    57    -h, --help                                                help for serve
    58        --jobs-url string                                     URL for the jobs system synchronization, redis or in-memory
    59        --konnectors-cmd string                               konnectors command to be executed
    60        --konnectors-oauthstate string                        URL for the storage of OAuth state for konnectors, redis or in-memory
    61        --lock-url string                                     URL for the locks, redis or in-memory
    62        --log-level string                                    define the log level (default "info")
    63        --log-syslog                                          use the local syslog for logging
    64        --mail-alert-address string                           mail address used for alerts (instance deletion failure for example)
    65        --mail-disable-tls                                    disable starttls on smtp (default true)
    66        --mail-host string                                    mail smtp host (default "localhost")
    67        --mail-local-name string                              hostname sent to the smtp server with the HELO command (default "localhost")
    68        --mail-noreply-address string                         mail address used for sending mail as a noreply (forgot passwords for example)
    69        --mail-noreply-name string                            mail name used for sending mail as a noreply (forgot passwords for example) (default "My Cozy")
    70        --mail-password string                                mail smtp password
    71        --mail-port int                                       mail smtp port (default 25)
    72        --mail-reply-to string                                mail address used to the reply-to (support for example)
    73        --mail-use-ssl                                        use ssl for mail sending (smtps)
    74        --mail-username string                                mail smtp username
    75        --mailhog                                             Alias of --mail-disable-tls --mail-port 1025, useful for MailHog
    76        --move-url string                                     URL for the move wizard (default "https://move.cozycloud.cc/")
    77        --onlyoffice-inbox-secret string                      Secret used for signing requests to the OnlyOffice server
    78        --onlyoffice-outbox-secret string                     Secret used for verifying requests from the OnlyOffice server
    79        --onlyoffice-url string                               URL for the OnlyOffice server
    80        --password-reset-interval string                      minimal duration between two password reset (default "15m")
    81        --rate-limiting-url string                            URL for rate-limiting counters, redis or in-memory
    82        --realtime-url string                                 URL for realtime in the browser via webocket, redis or in-memory
    83        --remote-allow-custom-port                            Allow to specify a port in request files for remote doctypes
    84        --sessions-url string                                 URL for the sessions storage, redis or in-memory
    85        --subdomains string                                   how to structure the subdomains for apps (can be nested or flat) (default "nested")
    86        --vault-decryptor-key string                          the path to the key used to decrypt credentials
    87        --vault-encryptor-key string                          the path to the key used to encrypt credentials
    88  ```
    89  
    90  ### Options inherited from parent commands
    91  
    92  ```
    93        --admin-host string   administration server host (default "localhost")
    94        --admin-port int      administration server port (default 6060)
    95    -c, --config string       configuration file (default "$HOME/.cozy.yaml")
    96        --host string         server host (default "localhost")
    97    -p, --port int            server port (default 8080)
    98  ```
    99  
   100  ### SEE ALSO
   101  
   102  * [cozy-stack](cozy-stack.md)	 - cozy-stack is the main command
   103