Skip to content

Commit b9479b6

Browse files
authored
Update deploy.md
1 parent a5b68b7 commit b9479b6

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

docs/deploy.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,42 +54,48 @@ Optional values in the .env file can be found under the [Environment variables](
5454

5555
Once you have the `.env` file configured, you are ready to start the building of the container.
5656

57-
### Docker
58-
#### Build the Docker container
57+
## Docker
58+
### Build the Docker container
5959
Once you have configured the **GitHub App** and updated the source code, you should be ready to build the container.
6060
- Change directory to inside the code base
6161
- `cd safe-settings/`
6262
- Build the container
6363
- `docker build -t safe-settings .`
6464
- This process should complete successfully and you will then have a **Docker** container ready for deployment
6565

66-
#### Run the Docker container
66+
### Run the Docker container
6767
Once the container has been successfully built, you can deploy it and start utilizing the **GitHub App**.
6868

69-
#### Start the container with docker-compose
69+
### Start the container with docker-compose
7070
If you have docker-compose installed, you can simply start and stop the **Docker** container with:
7171
- `cd safe-settings/; docker-compose --env-file .env up -d`
7272
This will start the container in the background and detached.
7373

74-
#### Start Docker container Detached in background
74+
### Start Docker container Detached in background
7575
- Start the container detached with port assigned (*Assuming port 3000 for the webhook*)
7676
- `docker run -d -p 3000:3000 safe-settings`
7777
- You should now have the container running in the background and can validate it running with the command:
7878
- `docker ps`
7979
- This should show the `safe-settings` alive and running
8080

81-
#### Start Docker container attached in forground (Debug)
81+
### Start Docker container attached in forground (Debug)
8282
- If you need to run the container in interactive mode to validate connectivity and functionality:
8383
- `docker run -it -p 3000:3000 safe-settings`
8484
- You will now have the log of the container showing to your terminal, and can validate connectivity and functionality.
8585

86-
#### Connect to running Docker container (Debug)
86+
### Connect to running Docker container (Debug)
8787
- If you need to connect to the container thats already running, you can run the following command:
8888
- `docker exec -it safe-settings /bin/sh`
8989
- You will now be inside the running **Docker** container and can perform any troubleshooting needed
9090

91-
### Deploy the app to AWS Lambda
91+
## Deploy the app to AWS Lambda
9292
[Serverless Framework Deployment of safe-settings on AWS](AWS-README.md)
93+
94+
### Proxy Support
95+
The AWS Lambda handler, `handler.js` uses a custom `Octokit` factory that creates Octokit with ___Proxied fetch___ instead of the regular ___fetch___ when the `http_proxy`/`https_proxy` env variables are set.
96+
97+
In the future we can use the same pattern to support proxy in all deployments of the app.
98+
9399
## Deploy the app in Kubernetes
94100

95101
### __Deploying using kubectl__

0 commit comments

Comments
 (0)