xrforge/manyfold/README.md

48 lines
2.1 KiB
Markdown
Raw Normal View History

# Manyfold container
The XRForge-serverimage is a pre-configured Manyfold container (reproducably via [nix](https://nixos.org) dockertools).
It also contains some extra's, to better fit an XR audience.
> To run it, see the [sysadmin](https://manyfold.app/sysadmin/) documentation of the [manyfold](https://github.com/manyfold3d/manyfold) project.
# Build the container-image
```bash
$ docker load < $(nix-build nix/docker.nix)
```
# Extra environment-variables
| environment variable | default | info |
|----------------------|------------|------------------------|
| `APPNAME` | `manyfold` | manyfold instance name |
| `THEME` | `default` | bootstrap theme |
| `NO_OVERLAYFS` | `` | disable the filesystem overlay mechanism |
| `NO_DEFAULTDB` | `` | disable the default db (activates manyfold installer) |
| `RCLONE_REMOTE` | `` | specify rclone remote name (without semicolon) to mount (by default rclone mounts+adds every rclone remote). Use this to specify a [combined](https://rclone.org/combine/) or [union](https://rclone.org/union/) remote|
# Default database / admin login
* email: `xrforge@localhost`
* login: `xrforge`
* password: `xrforge!1`
> please modify the password in the settings screen of the webinterface.
# Filesystem overlay-mechanism
The server-image will boot `manyfold/cli/manyfold.sh boot` and check for directory `/manifold` (in the container).
When found, it uses the files in there instead (`/manyfold/usr/src/app/public/404.html` instead of `/usr/src/app/public/404.html` e.g.).
# Remote model-drives
To enable rclone to mount network drives, the container must be run with FUSE-device support.
The quickest way is:
* add `-v ./manyfold/root/.config:/root/.config --cap-add SYS_ADMIN --security-opt apparmor:unconfined --device /dev/fuse` to the docker cmd
* add network drives by running `docker exec -it rclone config` in a running container
* profit!
> your drives will get automagically mounted and added to the database automagically (manifold.sh](manyfold/cli/manifold.sh) rclone_automount) during boot