diff --git a/README.md b/README.md index c0849a0..ad86984 100644 --- a/README.md +++ b/README.md @@ -38,3 +38,63 @@ To make deployment to run an instance for your mesh easy, Docker support is incl ## Chat If you're using this and have questions, or perhaps you want to join in on the dev effort and want to interact collaboratively, come chat with us on [#meshinfo on the SacValleyMesh Discord](https://discord.gg/sVHDNAAB). + +## Running + +### Docker Compose (preferred for 24/7 servers) + +#### Setup + +``` +git clone https://github.com/MeshAddicts/meshinfo.git +``` + +#### To Run + +Change to the directory. +``` +cd meshinfo +``` + +``` +docker compose down && git pull && docker compose up -d +``` + +#### To Update + +``` +docker compose down && git pull && docker compose up -d +``` + +## Development + +### Building a local Docker image + +Clone the repository. +``` +git clone https://github.com/MeshAddicts/meshinfo.git +``` + +If already existing, be sure to pull updates. +``` +git fetch && git pull +``` + +Build. Be sure to specify a related version number and suffix (this example `dev5` but could be your name or initials and a number) as this will help prevent collisions in your local image cache when testing. +``` +scripts/docker-build.sh 0.0.1dev5 +``` + +### Release + +Tag the release using git and push up the tag. The image will be build by GitHub automatically (see: https://github.com/MeshAddicts/meshinfo/actions/workflows/docker.yml). + +``` +git tag v0.0.0 && git push --tags +``` + +## Contributing + +We happily accept Pull Requests! + +TODO: Need to rewrite this section. diff --git a/docker-compose.yml b/docker-compose.yml index 7b7ad92..a26eb2b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -29,7 +29,7 @@ services: restart: always meshinfo: - image: ghcr.io/meshaddicts/meshinfo:0.0.68 + image: ghcr.io/meshaddicts/meshinfo:latest volumes: - ./output:/app/output environment: