-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Docker | ||
|
||
## Using docker-compose | ||
|
||
You may build and test your changes by using the compose file: | ||
|
||
docker-compose -f ./docker/docker-compose.yml up | ||
|
||
## Entering the build environment | ||
|
||
While in the repository root, to enter the environment and be presented with a | ||
shell: | ||
|
||
docker run -it --rm -u builder \ | ||
-v $PWD:/workspace ghcr.io/KaruroChori/vs-fltk:build-env | ||
|
||
This will mount your current directory as */workspace* inside the container. | ||
Your username will be *builder*. By default, you will not have root privileges | ||
(which are not necessary to build and test). However, you can use `sudo` if | ||
you need to run `apt` or any other commands that require root access. | ||
|
||
## Getting the image | ||
|
||
You can pull the image manually: | ||
|
||
docker pull ghcr.io/KaruroChori/vs-fltk:build-env | ||
|
||
If you use `docker-compose` or `docker run ...` the image will be pulled | ||
automatically the first time. | ||
|
||
|