Skip to content

Commit

Permalink
chore: 🎨 format docker compose and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
deivshon committed Mar 31, 2024
1 parent ef3e76c commit bbfd462
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ You can choose to compile and run pi-status natively or build a Docker image and

### Requirements

- Rust toolchain
- NodeJS
- Rust toolchain
- NodeJS

### Compilation

Expand Down Expand Up @@ -49,8 +49,8 @@ If you want to cross compile for your RPi 3/4 that is also possible with `make a

### Requirements

- Docker, including compose and buildx plugins
- **If** cross compiling: `qemu-user-static` and `qemu-user-static-binfmt`
- Docker, including compose and buildx plugins
- **If** cross compiling: `qemu-user-static` and `qemu-user-static-binfmt`

The quoted packages are found in Arch Linux repositories, you should find the corresponding ones for your distribution of choice

Expand All @@ -62,7 +62,7 @@ The second step depends on your Raspberry Pi target

2. RPi 3/4: `make docker-arm64`

RPi 2: `make docker-armv7`
RPi 2: `make docker-armv7`

If for some reason you want to try containerized pi-status on a amd64 machine, `make docker-amd64` is also available

Expand All @@ -74,5 +74,5 @@ After building the image and having it transferred to the target machine

## Endpoints

- `/` -> the web page to view the monitored resources data
- `/ws_data` -> WebSocket endpoint for monitored resources data in JSON format messages
- `/` -> the web page to view the monitored resources data
- `/ws_data` -> WebSocket endpoint for monitored resources data in JSON format messages
5 changes: 2 additions & 3 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ services:
container_name: pi-status
image: pi-status
ports:
#
- "8080:8080/tcp"
environment:
# These are NOT to be changed
Expand All @@ -15,7 +14,7 @@ services:
- PST_NET_DEVS=${PST_DOCKER_NET_DEVS}
- PST_THERMAL_DIR=${PST_DOCKER_THERMAL_DIR}
- PST_MOUNTS_FILE=${PST_DOCKER_MOUNTS_FILE}

# Uncomment to make containerized pi-status accept connections,
# but be aware that ALL connections will be accepted, so firewall
# as needed if you don't want to make your monitored resources data
Expand All @@ -33,5 +32,5 @@ services:

# Mount the volumes you want to monitor, host and container mount points must be the same
# The `:ro` at the end ensures they are mounted as read only
# e.g.
# e.g.
# - /mnt/my_volume:/mnt/my_volume:ro

0 comments on commit bbfd462

Please sign in to comment.