Skip to content

Commit 5fe9f78

Browse files
committed
Adds main README and LICENSE.
1 parent fb8171f commit 5fe9f78

File tree

6 files changed

+82
-19
lines changed

6 files changed

+82
-19
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017, Hasura.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+41-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,50 @@
1+
#Introduction
2+
This is a collection of ready to use base repos of common web frameworks,
3+
databases, CMSs that can be easily built as Docker images or integrated into
4+
a git based pipeline.
5+
6+
In every folder in this collection, you will be able to do any of the following:
7+
8+
- Use ``docker build`` to build your own image
9+
- Initialise a git repo, and run ``git push`` to push to github/gitlab that can
10+
be integrated with a docker registry like docker hub or gitlab's pipelines
11+
- Use ``docker run`` and get a running container. Basic configuration flags are
12+
specified in basic-docker-config.yaml.
13+
14+
The aim is to maintain a collection of quickstart up-to-date base repos that
15+
are production ready.
16+
117
#How to use this repo?
18+
To use any base-repo, do the following:
219

20+
- Clone this repo:
21+
``git clone https://github.com/hasura/docker-git-ci-templates``
22+
- Copy the relevant base-repo:
23+
``mv docker-git-ci-templates/nodejs-express my-node-project``
24+
- Initialize your own git repo: ``cd my-node-project && git init``
325

426
#Repo Structure
27+
Every base repo has the following structure:
28+
29+
```
30+
/
31+
--Dockerfile
32+
--basic-docker-config.yaml
33+
--README.md
34+
--app/
35+
```
536

37+
The README inside the base repo will contain instructions on what you
38+
can do next.
639

7-
#How to contribute?
40+
#Contribution
841

42+
Please contribute to this repository! Please visit github issues to
43+
see where you can pitch in.
944

45+
We want you to:
1046

47+
- Contribute towards and create more sample frameworks
48+
- Improve existing base repos based on your experience. Eg: make it more
49+
production ready, to improve docker-image build times, or to improve
50+
docker image sizes.

elasticsearch/Dockerfile

+3
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
FROM elasticsearch:latest
22

3+
#Copy conf
4+
ADD app/conf.yaml /elasticsearch/conf.yaml
5+

elasticsearch/docker-config.yaml

-7
This file was deleted.

mysql/README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
1+
#Description
2+
Runs a MySQL server
3+
This is a stateful service that exposes TCP endpoints
14

2-
Docker Quickstart Guide:
5+
#Docker Quickstart
6+
- docker run -d -p 3306:3306 \
7+
-e MYSQL_SOMETHING=asdf \
8+
-e MYSQL_SOMETHING=asdf \
9+
-e MYSQL_SOMETHING=asdf \
10+
-v $(pwd)/data=/var/lib/mysql/data \
11+
mysql:latest
312

4-
- docker build -t mysql-hasura:0.1
13+
#Git CI quickstart
14+
Typically, modify these files.
15+
Then git push origin master.
516

6-
RUN MYSQL DATABASE
7-
docker run --name mysql-wordpress -v /your/path/to/mysql:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=hasura -d -p 3306:3306 mysql-hasura:0.1
17+
#Build your own Docker image
18+
docker build -t my-mysql .
819

20+
#Advanced options
21+
MYSQL_ROOT_PASSWORD: set this option if you want to X

mysql/docker-config.yaml

-7
This file was deleted.

0 commit comments

Comments
 (0)