diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 34 insertions, 16 deletions
@@ -1,19 +1,37 @@ # Prism Launcher Meta + Scripts to generate jsons and jars that Prism Launcher will access. -## Deployment -It is recommended to use Docker to deploy the environment. - -- Clone this repo to a server -- Make sure it's writable by the container later: `chown -R 1337:1337 .` -- Configure `config/config_local.sh` - - The defaults should be fine (apart from committer email and name perhaps) -- Put your SSH key (which has push access to meta-upstream and meta-launcher) at `config/deploy.key` -- Pull meta- repos: `bash clone.sh` -- Customize docker-compose.yaml -- Run `docker-compose up -d --build` -- Observe Cron logs using `docker-compose logs -f` (Runs hourly by default) -- (Optional) Run once to fill caches: `docker-compose run meta update` - -For local development you can also use `docker-compose.local.yaml`. By default, it uses `UID=1000` and `GID=1000`. -Make sure it's the same as your host instance. +## Recommended Deployment + +Assuming you have a Flake-based NixOS configuration + +- Add Flake input: + + ```nix + { + inputs.prism-meta.url = "github:PrismLauncher/meta"; + } + ``` + +- Import NixOS module and configure + + ```nix + {inputs, ...}: { + imports = [inputs.prism-meta.nixosModules.default]; + services.blockgame-meta = { + enable = true; + settings = { + DEPLOY_TO_GIT = "true"; + GIT_AUTHOR_NAME = "Herpington Derpson"; + GIT_AUTHOR_EMAIL = "herpderp@derpmail.com"; + GIT_COMMITTER_NAME = "Herpington Derpson"; + GIT_COMMITTER_EMAIL = "herpderp@derpmail.com"; + }; + }; + } + ``` + +- Rebuild and activate! +- Trigger it `systemctl start blockgame-meta.service` +- Monitor it `journalctl -fu blockgame-meta.service` |