41 lines
1.6 KiB
Markdown
41 lines
1.6 KiB
Markdown
# Neo Roundtable
|
|
|
|
Self-hosted Neo Roundtable by Sky::NET.
|
|
|
|
## Requirements
|
|
- Debian (amd64) with Docker Engine and the Docker Compose plugin
|
|
- About 3 GB free disk for the images, plus room for your data
|
|
- 8 GB RAM recommended
|
|
- An access token from Sky::NET
|
|
|
|
## Install
|
|
```sh
|
|
curl -fsSL https://git.sn-s.net/neo/neo-roundtable/raw/branch/main/install | bash
|
|
```
|
|
The installer checks your system, then asks for your access token, an admin
|
|
name and password, and your two domains (Roundtable and Neo app). Nothing is
|
|
written before every question is answered.
|
|
|
|
It installs to `/opt/containers/neo-roundtable` and listens only on
|
|
`127.0.0.1:3060`. Put your own reverse proxy with TLS in front of it for both
|
|
domains. Settings live in `.env`.
|
|
|
|
## Everyday use
|
|
From the install folder:
|
|
- `./neo-admin status`: version, health, disk and last backup
|
|
- `./neo-admin update`: back up, then update to the latest release
|
|
- `./neo-admin rollback`: back to the previous release, if the database is unchanged
|
|
- `./neo-admin backup` and `./neo-admin restore <archive>`
|
|
- `./neo-admin reset-pwd <user>`
|
|
- `./neo-admin logs`
|
|
- `./neo-admin uninstall`: remove the containers, keep all data
|
|
- `./neo-admin uninstall --purge`: delete the installation and its data permanently
|
|
|
|
An existing installation from a source checkout: put `neo-admin` next to its
|
|
Compose file and run `./neo-admin adopt`.
|
|
|
|
## Good to know
|
|
- Backups cover the database, files, Neo originals and keys. Contacts Workshop
|
|
data is not included yet; back up its folder separately.
|
|
- Keep a copy of `.env`; it is not part of the backup.
|
|
- Neo Web and Contacts Workshop are off by default; switch them on in `.env`. |