-
Notifications
You must be signed in to change notification settings - Fork 34
Defaults
Matthew Knox edited this page May 30, 2017
·
4 revisions
On the first install of Concierge, the following modules are installed (if git is in the path and there is an internet connection, otherwise they must be manually installed):
Similar to the KPM table, this page is an honesty page.
| Name | Git URL | Description |
|---|---|---|
| boss | https://github.com/concierge/boss.git | A web-based admin control panel for Concierge. |
| config | https://github.com/concierge/config.git | Persistant configuration for Concierge. |
| creator | https://github.com/concierge/creator.git | Displays information about the creators of Concierge. |
| help | https://github.com/concierge/help.git | Displays module help. |
| kpm | https://github.com/concierge/kpm.git | Package Manager, assists with the installing and managing of packages. |
| ping | https://github.com/concierge/ping.git | Displays information about the current Concierge instance. |
| restart | https://github.com/concierge/restart.git | Restarts Concierge, performing a full code hotswap. |
| shutdown | https://github.com/concierge/shutdown.git | Performs a safe shutdown of Concierge. Equivalent to a CTRL-C. |
| update | https://github.com/concierge/update.git | Updates Concierge. |
| test | https://github.com/concierge/test.git | The default command line integration for Concierge. |
Additional modules can be installed into the modules directory. Refer to the KPM table for named modules.
Custom defaults can be specified by one of six approaches (in order of precedence):
- Set the environment variable
CONCIERGE_DEFAULTS_REPOto a custom first-run git repository. - Create a file called
defaults.jsonin the Concierge root directory. This file should have the following format (git URL, name):
[
["https://github.com/concierge/creator.git", "creator"],
["https://github.com/concierge/help.git", "help"],
["https://github.com/concierge/kpm.git", "kpm"],
["https://github.com/concierge/ping.git", "ping"],
["https://github.com/concierge/restart.git", "restart"],
["https://github.com/concierge/shutdown.git", "shutdown"],
["https://github.com/concierge/update.git", "update"],
["https://github.com/concierge/test.git", "test"]
]- Add the same structure as
defaults.jsoninto the system configuration file underdefaults.list. E.g.:
{
"defaults": {
"list": [
["https://github.com/concierge/creator.git", "creator"]
]
}
}- Add the same structure as
defaults.jsoninto thefirst-runmodule configuration file underlist. - Add the same structure as
defaults.jsonto an environment variable calledCONCIERGE_DEFAULTS. - Set any of the following to the url of a new table (like the one on this page) from which to look up defaults:
- System configuration file,
defaults.url -
first-runconfiguration file,url - Envirionment variable,
CONCIERGE_DEFAULTS_URL
- System configuration file,