repos / git-pr

commit

94b4779

parent

961b2fb

author

Eric Bower

date

2024-07-10 14:18:39 -0400 EDT

docs: readme

 1@@ -147,7 +147,9 @@ code; they cannot be ignored or else they will be upstreamed erroneously.
 2 
 3 # installation and setup
 4 
 5-Copy or create a `git-pr.toml` file inside `./data` directory:
 6+## setup
 7+
 8+[Copy](./git-pr.toml) or create a `git-pr.toml` file inside `./data` directory:
 9 
10 ```bash
11 mkdir data
12@@ -155,22 +157,38 @@ vim ./data/git-pr.toml
13 # configure file
14 ```
15 
16+## docker
17+
18 Run the ssh app image:
19 
20 ```bash
21-docker run -d -v ./data:/app/data \
22-  --name git-pr-ssh \
23-  ghcr.io/picosh/pico/git-ssh:latest
24+docker run -d -v ./data:/app/data ghcr.io/picosh/pico/git-ssh:latest
25 ```
26 
27 Run the web app image:
28 
29 ```bash
30-docker run -d -v ./data:/app/data \
31-  --name git-pr-web \
32-  ghcr.io/picosh/pico/git-web:latest
33+docker run -d -v ./data:/app/data ghcr.io/picosh/pico/git-web:latest
34+```
35+
36+## golang
37+
38+Clone this repo and then build the go binaries:
39+
40+```bash
41+make build
42 ```
43 
44+```bash
45+./build/ssh --config ./data/git-pr.toml
46+```
47+
48+```bash
49+./build/web --config ./data/git-pr.toml
50+```
51+
52+## done!
53+
54 Access the ssh app:
55 
56 ```bash
57@@ -189,7 +207,6 @@ curl localhost:3000
58 > This project is being actively developed and we have not reached alpha status
59 > yet.
60 
61-1. Guide for self-hosting `git-pr`
62 1. PR should be displayed as an event log
63 1. **Alpha status**
64 1. Git remote for repos

1@@ -1,5 +1,8 @@
2+# url is used for help commands
3 url = "pr.pico.sh"
4+# where we store the sqlite db, this toml file, git repos, and ssh host keys
5 data_dir = "./data"
6+# this gives users the ability to submit reviews and other admin permissions
7 admins = [
8   "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIHM2RPNgcyt+Tpb77uj0oQYZWLadfB8x8mqJFy0C7Y8P",
9   "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINlr0pScstAuTqs9Qr1KaMspHuFGO7cQMuvMMdJjbWG3"