Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Commit ac866c4

Browse files
author
Noah Hanjun Lee
authored
feat: add installation doc (#95)
1 parent abbba1f commit ac866c4

File tree

4 files changed

+67
-4
lines changed

4 files changed

+67
-4
lines changed

docs/concepts/deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ With approval, Gitploy waits until it matches the required approving approvals.
1212

1313
Rollback is the best way to recover while you fix the problems. Gitploy supports the rollback, and you can choose one of the successful deployments to rollback.
1414

15-
For best practice, you should lock the repository to block deploying by others. And the admin user has to take care of the repository until finishing to fix the problems.
15+
For best practice, you should lock the repository to block deploying by others until finishing to fix the problems. Gitploy provide the 'lock' feature in UI and Chatops.
1616

1717
*Note that if the ref of the selected deployment is a branch, Gitploy automatically references the commit SHA to prevent deploying the head of the branch.*

docs/images/github-oauth.png

72.3 KB
Loading

docs/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Gitploy
22

3-
Gitploy helps **you can build the advanced deployment pipeline in minutes**. It enables teams to deploy the application with lower risk and faster when to trigger a deployment. And the pipeline is configured with a simple, easy‑to‑read file that you commit to your git repository.
3+
![Gitploy](./images/gitploy.png)
4+
5+
---
46

5-
![Gitploy](./images/gitploy.png)
7+
Gitploy helps **you can build the advanced deployment pipeline in minutes**. It enables teams to deploy the application with lower risk and faster when to trigger a deployment. And the pipeline is configured with a simple, easy‑to‑read file that you commit to your git repository.

docs/tasks/installation.md

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,62 @@
1-
# Installation
1+
# Installation
2+
3+
This article explains how to install the Gitploy server for GitHub.
4+
5+
## Step 1: Preparation
6+
7+
### Provision an instance
8+
9+
The server should be installed on a server or virtual machine with standard http and https ports open.
10+
11+
### Create an OAuth Application
12+
13+
[Create a GitHub OAuth application.](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) The Client Key and Client Secret are used to authorize access to GitHub resources.
14+
15+
*The authorization callback URL must match with the format:* `GITPLOY_SERVER_PROTO://GITPLOY_SERVER_HOST/signin`.
16+
17+
Figure) Github OAuth
18+
19+
![Github OAuth](../images/github-oauth.png)
20+
21+
## Step 2: Download
22+
23+
The server is distributed as a Docker image. The image is self-contained and does not have any external dependencies. We recommend to use the last version.
24+
25+
```
26+
docker pull gitployio/gitploy:0.2
27+
```
28+
29+
## Step 3: Configuration
30+
31+
The server is configured using environment variables. This article only configures with least environment. See [Configurations](../references/configurations.md) for a complete list of configuration options.
32+
33+
* **GITPLOY_SERVER_HOST**:
34+
Required string value configures the user-facing hostname. This value is used to create webhooks and redirect urls.
35+
36+
* **GITPLOY_SERVER_PROTO**:
37+
Optional string value configures the user-facing protocol. This value is used to create webhooks and redirect urls. It can be one of them: `http` or `https`, and the default value is `https`.
38+
39+
* **GITPLOY_GITHUB_CLIENT_ID**:
40+
Required string value configures the GitHub OAuth client id. This is used to authorize access to GitHub on behalf of a Gitploy user.
41+
42+
* **GITPLOY_GITHUB_CLIENT_SECRET**:
43+
Required string value configures the GitHub OAuth client secret. This is used to authorize access to GitHub on behalf of a Gitploy user.
44+
45+
## Step 4: Start server
46+
47+
The server container can be started with the below command. The container is configured through environment variables.
48+
49+
```shell
50+
docker run \
51+
--volume=/var/lib/gitploy:/data \
52+
--env=GITPLOY_SERVER_HOST={{GITPLOY_SERVER_HOST}} \
53+
--env=GITPLOY_SERVER_PROTO={{GITPLOY_SERVER_PROTO}} \
54+
--env=GITPLOY_GITHUB_CLIENT_ID={{GITPLOY_GITHUB_CLIENT_ID}} \
55+
--env=GITPLOY_GITHUB_CLIENT_SECRET={{GITPLOY_GITHUB_CLIENT_SECRET}} \
56+
--publish=80:80 \
57+
--publish=443:443 \
58+
--restart=always \
59+
--detach=true \
60+
--name=gitploy \
61+
gitployio/gitploy:0.2
62+
```

0 commit comments

Comments
 (0)