Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
freeziyou committed Jan 29, 2024
1 parent 5462d07 commit 73014f2
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
</p>

<!-- SHIELD GROUP -->

[![][github-logo-shield]][github-logo-link]
[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
Expand Down Expand Up @@ -140,6 +141,7 @@ First, download the `docker-compose.yml` and `.env` file; they contain the confi
$ wget https://raw.githubusercontent.com/ConnectAI-E/GitMaya/main/deploy/docker-compose.yml
$ wget https://raw.githubusercontent.com/ConnectAI-E/GitMaya/main/deploy/.env.example -O .env
```

</details>

<details>
Expand All @@ -149,7 +151,7 @@ $ wget https://raw.githubusercontent.com/ConnectAI-E/GitMaya/main/deploy/.env.ex

</summary>

Then, you need to configure the .env file. You should replace the variables with your own GitHub App information, which created in [Step 1](#step-1-install-github-application).
Then, you need to configure the `.env` and `docker-compose.yml` file. You should replace the variables with your own GitHub App information, which created in [Step 1](#step-1-install-github-application).

```fish
$ vim .env
Expand Down Expand Up @@ -177,6 +179,26 @@ DOMAIN=127.0.0.1

> **NOTE**: **file supports multi-line string, so the .pem file could be pasted into `.env` file directly**
Configure the `docker-compose.yml` file.

```fish
$ vim docker-compose.yml
```

Replace `VITE_OAUTH_HOST` to your own domain name.

```fish
proxy:
image: connectai/gitmaya-proxy
environment:
- VITE_OAUTH_HOST=https://gitmaya.com
ports:
- "8000:80"
- "8001:81"
volumes:
- /var/run/docker.sock:/tmp/docker.sock:ro
```

</details>

<details>
Expand All @@ -191,6 +213,7 @@ It will init database in first time, thus it may contain a few error messages in
```fish
$ docker-compose up -d
```

</details>

<!-- > \[!NOTE]
Expand Down

0 comments on commit 73014f2

Please sign in to comment.