Install and run a site
Install and run a site
The awhere commands you use most, and the containers a site is made of
This section is for the people who install and run an aWhere server. All the work is done with the awhere command. Managing users and apps is done on the web, in Administer.
Common commands
| I want to | Command | Details |
|---|---|---|
| Install a new site | awhere setup | Install a new site |
| See the state of the site | awhere status | Install a new site |
| Check readiness without changing anything | awhere preflight | Preflight |
| Upgrade to a new Release | awhere upgrade <version> | Upgrade |
| Go back to the previous Release | awhere rollback | Roll back |
| Move a v4 site to this Release | awhere setup --from-v4 <path> --v4-prefix <prefix> | Upgrade from v4 |
| Read logs, or stop and start a container | awhere logs <component> -fawhere stop <component>awhere start <component> | Troubleshooting |
| Make the first administrator (if setup did not) | awhere admin | Install a new site |
<version> is a Release number, such as 5.1.0. <component> is the name of a container, such as core-services. awhere status lists all the names. To change the settings of a node, see Node settings.
What is in a site
A site is several containers in two groups: nodes (the back end) and apps (the web pages users open). At start, core-services comes up first, then the other nodes, then the apps.
| Container | What it does | Required |
|---|---|---|
core-services | The API gateway at /api. Manages users, Items, installed apps and the state of the system. | Yes |
authorization-server | The sign-in page. Issues tokens. | Yes |
item-services | Items, tables and Records. | Yes |
file-services | Stores and serves files, makes thumbnails, issues signed links. | Yes |
logging-services | The Audit log. | Yes |
tile-services, tile-indexer | Build map tiles. | If you use maps |
realtime-services | Updates data on screen at once, with no refresh. | If you want it |
background-services | Imports data from files. | If you import data |
user-provider-ldap | Sign-in with an LDAP account. | If you use LDAP |
portal | The Portal, the platform's front page. It is at / and takes every path that no other container takes, including the 404 page. | Yes (core App) |
account, configuration, data-studio, drive, form-studio, map-studio, app-studio, widgets, logging | The apps. | Optional (Apps and the Marketplace) |