You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/deploy.md
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,42 +54,48 @@ Optional values in the .env file can be found under the [Environment variables](
54
54
55
55
Once you have the `.env` file configured, you are ready to start the building of the container.
56
56
57
-
###Docker
58
-
####Build the Docker container
57
+
## Docker
58
+
### Build the Docker container
59
59
Once you have configured the **GitHub App** and updated the source code, you should be ready to build the container.
60
60
- Change directory to inside the code base
61
61
-`cd safe-settings/`
62
62
- Build the container
63
63
-`docker build -t safe-settings .`
64
64
- This process should complete successfully and you will then have a **Docker** container ready for deployment
65
65
66
-
####Run the Docker container
66
+
### Run the Docker container
67
67
Once the container has been successfully built, you can deploy it and start utilizing the **GitHub App**.
68
68
69
-
####Start the container with docker-compose
69
+
### Start the container with docker-compose
70
70
If you have docker-compose installed, you can simply start and stop the **Docker** container with:
71
71
-`cd safe-settings/; docker-compose --env-file .env up -d`
72
72
This will start the container in the background and detached.
73
73
74
-
####Start Docker container Detached in background
74
+
### Start Docker container Detached in background
75
75
- Start the container detached with port assigned (*Assuming port 3000 for the webhook*)
76
76
-`docker run -d -p 3000:3000 safe-settings`
77
77
- You should now have the container running in the background and can validate it running with the command:
78
78
-`docker ps`
79
79
- This should show the `safe-settings` alive and running
80
80
81
-
####Start Docker container attached in forground (Debug)
81
+
### Start Docker container attached in forground (Debug)
82
82
- If you need to run the container in interactive mode to validate connectivity and functionality:
83
83
-`docker run -it -p 3000:3000 safe-settings`
84
84
- You will now have the log of the container showing to your terminal, and can validate connectivity and functionality.
85
85
86
-
####Connect to running Docker container (Debug)
86
+
### Connect to running Docker container (Debug)
87
87
- If you need to connect to the container thats already running, you can run the following command:
88
88
-`docker exec -it safe-settings /bin/sh`
89
89
- You will now be inside the running **Docker** container and can perform any troubleshooting needed
90
90
91
-
###Deploy the app to AWS Lambda
91
+
## Deploy the app to AWS Lambda
92
92
[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.
0 commit comments