56 lines
2.6 KiB
Markdown
56 lines
2.6 KiB
Markdown
# 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 **single** rclone remote name (without semicolon) to mount |
|
|
| `UPLOAD_PATH` | `/mnt/models`| specify default library where user-files are uploaded (regular dir or mounted rclone path) |
|
|
|
|
# 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 `/manyfold` (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 network-drives (with models)
|
|
|
|
> Thanks to [rclone](https://rclone.org) network-drives automatically show up as manyfold libraries.
|
|
|
|
|
|
|
|
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 (by [manyfold.sh](cli/manyfold.sh) `rclone_automount`-cmd) during container boot.
|
|
|
|
> NOTE: by default all rclone remotes automagically show up as separate manyfold libraries, however use `RCLONE_REMOTE` this to specify a [combined](https://rclone.org/combine/) or [union](https://rclone.org/union/) rclone remote.
|
|
|
|
TIP: use **alphanumeric** names for rclone remotes (manyfold libraries choke on dot- or other special-characters)
|
|
|