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

     1  ## cozy-stack instances add
     2  
     3  Manage instances of a stack
     4  
     5  ### Synopsis
     6  
     7  
     8  cozy-stack instances add allows to create an instance on the cozy for a
     9  given domain.
    10  
    11  If the COZY_DISABLE_INSTANCES_ADD_RM env variable is set, creating and
    12  destroying instances will be disabled and the content of this variable will
    13  be used as the error message.
    14  
    15  
    16  ```
    17  cozy-stack instances add <domain> [flags]
    18  ```
    19  
    20  ### Examples
    21  
    22  ```
    23  $ cozy-stack instances add --passphrase cozy --apps drive,photos,settings,home,store cozy.localhost:8080
    24  ```
    25  
    26  ### Options
    27  
    28  ```
    29        --apps strings              Apps to be preinstalled
    30        --context-name string       Context name of the instance
    31        --couch-cluster int         Specify the CouchDB cluster where the instance will be created (-1 means the default) (default -1)
    32        --dev                       To create a development instance (deprecated)
    33        --disk-quota string         The quota allowed to the instance's VFS
    34        --domain-aliases strings    Specify one or more aliases domain for the instance (separated by ',')
    35        --email string              The email of the owner
    36        --franceconnect_id string   The identifier for checking authentication with FranceConnect
    37    -h, --help                      help for add
    38        --locale string             Locale of the new cozy instance (default "en")
    39        --magic_link                Enable authentication with magic links sent by email
    40        --oidc_id string            The identifier for checking authentication from OIDC
    41        --passphrase string         Register the instance with this passphrase (useful for tests)
    42        --public-name string        The public name of the owner
    43        --settings string           A list of settings (eg context:foo,offer:premium)
    44        --sponsorships strings      Sponsorships of the instance (comma separated list)
    45        --swift-layout int          Specify the layout to use for Swift (from 0 for layout V1 to 2 for layout V3, -1 means the default) (default -1)
    46        --tos string                The TOS version signed
    47        --trace                     Show where time is spent
    48        --tz string                 The timezone for the user
    49        --uuid string               The UUID of the instance
    50  ```
    51  
    52  ### Options inherited from parent commands
    53  
    54  ```
    55        --admin-host string   administration server host (default "localhost")
    56        --admin-port int      administration server port (default 6060)
    57    -c, --config string       configuration file (default "$HOME/.cozy.yaml")
    58        --host string         server host (default "localhost")
    59    -p, --port int            server port (default 8080)
    60  ```
    61  
    62  ### SEE ALSO
    63  
    64  * [cozy-stack instances](cozy-stack_instances.md)	 - Manage instances of a stack
    65