Skip to content

Commit

Permalink
Update README and use latest tag for docker-compose
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinelliott committed Jun 28, 2024
1 parent bcc5804 commit 7065e46
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 1 deletion.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 7065e46

Please sign in to comment.