Skip to content

Commit

Permalink
dev-env: adding docker compose based env
Browse files Browse the repository at this point in the history
  • Loading branch information
ericjohnson97 committed Feb 22, 2024
1 parent 274bab8 commit ed127fb
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ Pipfile
Pipfile.lock
poetry.lock
registry/
workspace/

15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,18 @@ BlueOS is designed to perform optimally across a wide range of systems. Our late
- **amd64:** This is the architecture used by most desktop and laptop computers. A typical example is any modern PC running a 64-bit version of Linux. **Not fully supported.**

Right now we officially support the Raspberry Pi 3 and 4, but the system should "just work" on all listed architectures with the correct docker binds.

## Deveompment Environment

Docker based development environment is available for via the dev.yml docker compose file. This will start a development environment with all the required services as well as mount all of the needed directories in this repository for development.

```bash
docker compose -f dev.yml up
```

when restarting the development environment you may need to remove the volumes to ensure that the development environment is clean.

```bash
docker compose -f dev.yml down
```

18 changes: 18 additions & 0 deletions dev.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: '3.7'
services:
blueos-core:
image: bluerobotics/blueos-core:1.2.0-beta.6
container_name: blueos-core
privileged: true
network_mode: host
volumes:
- ./core/start-blueos-core:/usr/bin/start-blueos-core
- ./core/services:/home/pi/services
- ./workspace/config:/root/.config
- ./workspace/userdata:/usr/blueos/userdata
- ./workspace/logs:/var/logs/blueos
- /etc/resolv.conf:/etc/resolv.conf
- /run/udev:/run/udev
- /etc/machine-id:/etc/machine-id
- /var/run/docker.sock:/var/run/docker.sock
pid: "host"

0 comments on commit ed127fb

Please sign in to comment.