From fd4a7b661c23f40863e20d5b44722c7fc3b96649 Mon Sep 17 00:00:00 2001 From: Unknown <07fi123@gmail.com> Date: Wed, 25 Mar 2020 18:11:55 -0500 Subject: [PATCH] spelling --- README.md | 36 +++++++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 15c732e..98b6414 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,14 @@ Each docker service defined in the `docker-compose.yml` file has a specific job - Gitea: the git remote host (think github clone) - Drone: Ci server / runner - Nginx-proxy: reverse proxy for using one docker host while routing to many domain names. -- Letsencrypt companion: handles the renewal of ssl certs automagicaly! +- Let's Encrypt companion: handles the renewal of ssl certs automagicaly! ## Lets get started! To get started clone down this repository. Observe the contents of `example.env`, this file is an example of the main configuration file for the docker hosts. -Each of these fields is required and may include differences in configuration depnding on the ending configuration. As writen `example.env` assumes that one would like to use every possible option. +Each of these fields are required and may include differences in configuration depending on the ending configuration. As written `example.env` assumes that one should like to use every possible option. -Each section corisponds to the assciated `docker-compose` directive. +Each section corresponds to the associated service `docker-compose` directive. ``` #LetsEncrypt LETSENCRYPT_DEFAULT_EMAIL=youremail@example.com @@ -38,14 +38,28 @@ DRONE_RUNNER_CAPACITY=2 DRONE_RUNNER_NAME=drone-runner ``` -In order to configure drone we must run the cluster without drone Oauth configuration so start up with: +#### Considerations for drone + +Before running the service cluster we must tell `nginx-proxy` that the domain with drone will be running with extra http headers. Modify the file located in the `proxy/vhost` directory to be named with the following schema `yourDronedomain.com_location` this tells the proxy to only apply these rules to the drone domain. + +Make sure the following is in the file. + +``` +# pass through headers +proxy_set_header X-Real-IP $remote_addr; +proxy_set_header X-Forwarded-For $remote_addr; +proxy_set_header X-Forwarded-Proto $scheme; +``` + +In order to configure drone with Gitea we must run the cluster without drone Oauth configuration so start up with: + ``` docker-compose up -d ``` -Notice that `DRONE_GITEA_CLIENT_ID` and `DRONE_GITEACLIENT_SECRET` will be need to be filled in after createing a Oauth application in gitea. -Drone has documentaion [here](https://docs.drone.io/server/provider/gitea/). -Follow the tutorial and edit the file with the correct values then restart the services. DONT FORGET TO SAVE! +Notice that `DRONE_GITEA_CLIENT_ID` and `DRONE_GITEACLIENT_SECRET` will be need to be filled in after creating a Oauth application in Gitea. Drone has documentation [here](https://docs.drone.io/server/provider/gitea/). + +Follow the tutorial and edit the file with the correct values generated by the Oauth Challenge. ``` docker-compose down && docker-compose up -d @@ -55,14 +69,14 @@ That should do it, you now have a running remote repo / Ci! Happy codeing! ## Troubleshooting -Althought this configuration should work for most people there are some gotchas that may trip some people up. +Although this configuration should work for most people there are some gotchas that may trip some people up. There are some assumptions taken by the configuration: -## Requirments - A publicly reachable host on port 80 and 443, required by letsencrypt -- A Domain that is controled by a a DNS provider that supports DNSSEC, required by letsencrypt +- A Domain that is controlled by a a DNS provider that supports DNSSEC, required by letsencrypt - A docker host that can expose port 80 and 443 on the host, ngnx-proxy - Unique dns sub domains for Drone and gitea. ## Help, It wont work with my configuration! *Dont panic ! Remember the hitch hikers guide!* -This configuration may not meet the needs of people on networks that do not suport the above. Feel free to fork and hack away if that's the case ! If something just isn't lineing up drop us a Issue! We are happy to help! + +This configuration may not meet the needs of people on networks that do not suport the above. Feel free to fork and hack away if that's the case ! If something just isn't lineing up drop us a Issue! We are happy to help! \ No newline at end of file