Skip to content

Commit 348cc22

Browse files
committed
Document cp.role
1 parent f00d73b commit 348cc22

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/INSTALL.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,26 @@ Bootstrapper can run without any changes to `/root/apnscp-vars.yml`. The followi
217217
- **mysqld_per_account_innodb**: (true/false) places tables + data in an aggregate InnoDB pool for higher performance or per account for resource enforcement. An account over quota can cause a cyclic crash in MySQL/MariaDB 5.0+ on recovery. **You have been warned**. Ensure [Argos](https://hq.apiscp.com/monitoring-with-monit-argos/) is setup if enabled.
218218
- **data_center_mode**: (true/false) ensure all resources that ApisCP can account for are accounted. Also enables the pernicious bastard `mysqld_per_account_innodb`!
219219

220+
### Specialized roles
221+
**New in 3.2.45**
222+
223+
After installation, the platform may be reconfigured on-the-fly for a specialzied role using [cp.role Scope](admin/Scopes.md). The table summarizes available modes of operation. All free licenses may be generated through [my.apiscp.com](https://my.apiscp.com).
224+
225+
```bash
226+
# Assign platform as a development server
227+
cpcmd scope:set cp.role dev
228+
```
229+
230+
| Role | Remarks | Free |
231+
| ----------- | ------------------------------------------------------------ | :--: |
232+
| data-center | mod_pagespeed and database quotas enforced. Service cache pooling. [cp-proxy](admin/Panel%20proxy.md) recommended. [xfs filesystem](admin/Resource%20enforcement.md#project-quotas) highly recommended. | |
233+
| default | Single node. Caches unshared among additional machines. | |
234+
| dev | May only host .test TLDs. Operationally same a revolving monthly Pro license. ||
235+
| dns-only | Cannot host domains. Intended for [PowerDNS](admin/dns/PowerDNS.md). ||
236+
| low-memory | Pared down experience for use on 1 GB machines. | |
237+
| proxy | For use with [cp-proxy](admin/Panel%20proxy.md). Implies low-memory. Includes Nodejs support. ||
238+
| supervisor | Management framework. No UI, no auxiliary services (ftp, http, mail). ||
239+
220240
### Setting FQDN for SSL/Email
221241

222242
All servers should have a fully-qualified domain name ([FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name)). Failure to have one will cause email to fail, including the installation notice. Moreover, Let's Encrypt will fail issuance. A FQDN must at least contain 1 dot:

0 commit comments

Comments
 (0)