mirror of
https://github.com/dashpay/dash.git
synced 2024-12-25 20:12:57 +01:00
5e04b9f1d4
## Issue being fixed or feature implemented Make Dash on Docker Hub easier to find, a search on `dash` there does not provide the result. ## What was done? Improved Docker documentation in `contrib/containers/README.md` ## How Has This Been Tested? n/a ## Breaking Changes n/a ## Checklist: _Go over all the following points, and put an `x` in all the boxes that apply._ - [x] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have added or updated relevant unit/integration/functional/e2e tests - [x] I have made corresponding changes to the documentation - [ ] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_
31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
## Containers
|
|
|
|
This directory contains configuration files for containerization utilities.
|
|
|
|
Currently two Docker containers exist, `ci` defines how Dash's GitLab CI container is built and the `dev` builds on top of the `ci` to provide a containerized development environment that is as close as possible to CI for contributors! See also [Dash on Docker Hub](https://hub.docker.com/u/dashpay) i.e. for the [dashd container](https://hub.docker.com/r/dashpay/dashd).
|
|
|
|
### Usage Guide
|
|
|
|
We utilise edrevo's [dockerfile-plus](https://github.com/edrevo/dockerfile-plus), a syntax extension that
|
|
leverages Docker [BuildKit](https://docs.docker.com/develop/develop-images/build_enhancements/) to reduce
|
|
the amount of repetitive code.
|
|
|
|
As BuildKit is opt-in within many currently supported versions of Docker (as of this writing), you need to
|
|
set the following environment variables before continuing. While not needed after the initial `docker-compose build`
|
|
(barring updates to the `Dockerfile`), we recommend placing this in your `~/.bash_profile`/`~/.zshrc` or equivalent
|
|
|
|
```bash
|
|
export DOCKER_BUILDKIT=1
|
|
export COMPOSE_DOCKER_CLI_BUILD=1
|
|
```
|
|
|
|
After that, it's simply a matter of building and running your own development container. You can use extensions
|
|
for your IDE like Visual Studio Code's [Remote Containers](https://code.visualstudio.com/docs/remote/containers)
|
|
to run terminal commands from inside the terminal and build Dash Core.
|
|
|
|
```bash
|
|
cd contrib/containers/develop
|
|
docker-compose build
|
|
docker-compose run container
|
|
```
|