Skip to content

Commit 9650dbc

Browse files
author
Camille
authored
Add README.md with development guidelines (#32)
* Create README.md
1 parent f576db4 commit 9650dbc

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Openware docker images
2+
3+
This repository contains docker images maintained by openware team. Mostly blockchain cryptonodes.
4+
You can find the list of available images and tag here: https://quay.io/organization/openware
5+
6+
## Development guidelines
7+
8+
We are focusing our efforts to keep a high level of trust and security on those images.
9+
Please follow the following principles when developing an image:
10+
11+
1. Use official images as source (ex: debian:buster, alpine, python), don't use sources from third parties
12+
2. Install dependencies by downloading from official repositories (do not add them to the git reposity)
13+
3. Use recent versions
14+
4. The target application should be downloaded from well identified sources (ex: github official repository releases)
15+
5. Store the checksums of the binaries you install and check them during the build in the Dockerfile.
16+
See the following example: [electrum/Dockerfile](./electrum/Dockerfile) and [electrum/checksum.sha256](./electrum/checksum.sha256)
17+
6. The application version must be stored in VERSION file, the content is passed as argument during the build and it's used to tag the image.
18+
It **must be used to download the application binaries or sources**
19+
You can build manually with the following command: ```docker build --build-arg VERSION=1.2.3```
20+
7. The image should contain a README.md with instructions to do basic operations
21+
8. Include a docker-compose.yml file with example how to deploy a testnet and mainnet node (add configuration files if necessary)
22+
9. Create volumes for data directories (blockchain storage and wallets)

0 commit comments

Comments
 (0)