@@ -55,9 +55,9 @@ The subdomain / domain *optional* config options can be configured as follows:
55
55
}
56
56
```
57
57
58
- * ` name ` - Project name, used as the subdomain of the primary site, e.g. ` my-project `
59
- * ` tld ` - TLD of the project, e.g. ` my-company.local `
60
- * ` domains ` - Custom domains used by the project, either for main or sub sites.
58
+ - ` name ` - Project name, used as the subdomain of the primary site, e.g. ` my-project `
59
+ - ` tld ` - TLD of the project, e.g. ` my-company.local `
60
+ - ` domains ` - Custom domains used by the project, either for main or sub sites.
61
61
62
62
Note: Altis does not manage the host entries for subdomains or custom domains, you'll need to manage those manually, via
63
63
editing ` /etc/hosts ` in Linux / macOS, or ` C:\Windows\System32\Drivers\etc\hosts ` in Windows. Altis however tries to detect if those
@@ -88,46 +88,45 @@ started!
88
88
### Multisite Subdomains / Custom domains support
89
89
90
90
Altis v12 introduced experimental support for multisite subdomains and custom domains. In order to support custom (sub)domains,
91
- Altis is using [ ` mkcert ` ] ( https://github.com/FiloSottile/mkcert ) to generate SSL certificates based on a custom generated Root
92
- Certificate Authority that is uniquely-generated and trusted on the host machine upon installation. This allows Altis local-server
93
- to generate local SSL certificates that is automatically trusted, which provides a convenient and seamless local development
94
- experience.
91
+ Altis uses [ ` mkcert ` ] ( https://github.com/FiloSottile/mkcert ) to generate SSL certificates based on a generated Root
92
+ Certificate Authority (CA) that is uniquely-generated and trusted on the host machine upon installation. This allows Altis
93
+ local-server to generate local SSL certificates that is automatically trusted, which provides a convenient and seamless local
94
+ development experience.
95
95
96
96
Note: Altis local-server automatically collects domains names to issue the SSL certificate for, based on Altis configuration
97
97
in ` composer.json ` , namely the ` altis.modules.local-server ` tree, specifically the ` name ` , ` tld ` , and ` domains ` config parameters.
98
98
99
99
## Available Commands
100
100
101
- * ` composer server start [--xdebug=<mode>] [--mutagen] ` - Starts the containers.
102
- * ` --xdebug=<mode> ` will enable Xdebug. The ` mode ` is optional and defaults to ` debug ` . Available values
101
+ - ` composer server start [--xdebug=<mode>] [--mutagen] ` - Starts the containers.
102
+ - ` --xdebug=<mode> ` will enable Xdebug. The ` mode ` is optional and defaults to ` debug ` . Available values
103
103
are ` off ` , ` develop ` , ` debug ` , ` profile ` , ` coverage ` , ` gcstats ` and ` trace ` .
104
- * ` --mutagen ` will enable Mutagen for container file sharing.
105
- * ` composer server stop [<service>] [--clean] ` - Stops the containers or specified service.
106
- * ` --clean ` will also stop the proxy container if no service is specified, only use this if you have no other instances of Local
104
+ - ` --mutagen ` will enable Mutagen for container file sharing.
105
+ - ` composer server stop [<service>] [--clean] ` - Stops the containers or specified service.
106
+ - ` --clean ` will also stop the proxy container if no service is specified, only use this if you have no other instances of Local
107
107
Server
108
- * ` --tmp ` will mount the PHP container's ` /tmp ` directory to ` .tmp ` in your project root. This is useful for debugging
108
+ - ` --tmp ` will mount the PHP container's ` /tmp ` directory to ` .tmp ` in your project root. This is useful for debugging
109
109
with ` --xdebug=profile ` as the Cachegrind files are easily available
110
- * ` composer server restart [<service>] ` - Restart a given container, or all containers if none is provided. Available values
110
+ - ` composer server restart [<service>] ` - Restart a given container, or all containers if none is provided. Available values
111
111
are ` nginx ` , ` php ` , ` db ` , ` redis ` , ` cavalcade ` , ` tachyon ` , ` s3 ` and ` elasticsearch ` .
112
- * ` composer server destroy [--clean] ` - Stops and destroys all containers.
113
- * ` --clean ` will also destroy the proxy container, only use this if you have no other instances of Local Server
114
- * ` composer server status ` - Displays the status of all containers.
115
- * ` composer server ssl ` - Shows the status of local-server SSL certificate.
116
- * ` composer server ssl install ` - Install ` mkcert ` locally and set it up to prepare for SSL generation.
117
- * ` composer server ssl generate custom-domain.com ` - (re)generates the local-server SSL certificate
112
+ - ` composer server destroy [--clean] ` - Stops and destroys all containers.
113
+ - ` --clean ` will also destroy the proxy container, only use this if you have no other instances of Local Server
114
+ - ` composer server status ` - Displays the status of all containers.
115
+ - ` composer server ssl ` - Shows the status of local-server SSL certificate.
116
+ - ` composer server ssl install ` - Install ` mkcert ` locally and set it up to prepare for SSL generation.
117
+ - ` composer server ssl generate custom-domain.com ` - (re)generates the local-server SSL certificate
118
118
including ` custom-domain.com `
119
- * ` composer server ssl exec -- [<command>] ` - Execute custom ` mkcert ` commands, e.g. ` -uninstall ` to revoke the root CA
120
- * ` composer server logs <service> ` - Tail the logs from a given service, defaults to ` php ` , available options
119
+ - ` composer server ssl exec -- [<command>] ` - Execute custom ` mkcert ` commands, e.g. ` -uninstall ` to revoke the root CA
120
+ - ` composer server logs <service> ` - Tail the logs from a given service, defaults to ` php ` , available options
121
121
are ` nginx ` , ` php ` , ` db|mysql|sql ` , ` redis ` , ` cavalcade ` , ` tachyon ` , ` s3 ` and ` elasticsearch ` .
122
- * ` composer server shell ` - Logs in to the PHP container.
123
- * ` composer server cli|wp -- <command> ` - Runs a WP CLI command. Use either ` cli ` or ` wp ` . For example,
122
+ - ` composer server shell ` - Logs in to the PHP container.
123
+ - ` composer server cli|wp -- <command> ` - Runs a WP CLI command. Use either ` cli ` or ` wp ` . For example,
124
124
` composer server cli -- info ` or ` composer server wp -- info ` . Do not include ` wp ` in ` <command> ` .
125
- * ` composer server cli -- db import database.sql ` - Imports a database file located in the project root.
126
- * ` composer server create-alias ` - Create a WP CLI alias. Useful if you have WP CLI installed locally.
127
- * ` composer server exec -- <command> ` - Runs any command on the PHP container.
128
- * ` composer server db ` - Logs into MySQL on the DB container.
129
- * ` composer server db info ` - Print MySQL connection details.
130
- * ` composer server db (sequel|spf) ` - Opens a connection to the database in [ Sequel Pro] ( https://sequelpro.com )
131
- or [ Sequel Ace] ( https://sequel-ace.com/ ) .
132
- * ` composer server db (tableplus|tbp) ` - Opens a connection to the database in [ Table Plus] ( https://tableplus.com/ ) .
133
- * ` composer server import-uploads ` - Syncs files from ` content/uploads ` to the S3 container.
125
+ - ` composer server cli -- db import database.sql ` - Imports a database file located in the project root.
126
+ - ` composer server create-alias ` - Create a WP CLI alias. Useful if you have WP CLI installed locally.
127
+ - ` composer server exec -- <command> ` - Runs any command on the PHP container.
128
+ - ` composer server db ` - Logs into MySQL on the DB container.
129
+ - ` composer server db info ` - Print MySQL connection details.
130
+ - ` composer server db (sequel|spf) ` - Opens a connection to the database in [ Sequel Ace] ( https://sequel-ace.com/ ) .
131
+ - ` composer server db (tableplus|tbp) ` - Opens a connection to the database in [ Table Plus] ( https://tableplus.com/ ) .
132
+ - ` composer server import-uploads ` - Syncs files from ` content/uploads ` to the S3 container.
0 commit comments