repos / pico

commit

c9a1321

parent

b26ca56

author

Eric Bower

date

2024-04-22 14:51:44 +0000 UTC

chore: docs

 1@@ -1,31 +1,31 @@
 2 {
 3-    // Use IntelliSense to learn about possible attributes.
 4-    // Hover to view descriptions of existing attributes.
 5-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 6-    "version": "0.2.0",
 7-    "configurations": [
 8-        {
 9-            "name": "Debug App",
10-            "type": "go",
11-            "request": "launch",
12-            "mode": "auto",
13-            "program": "${workspaceFolder}/cmd/${input:service}/${input:type}/main.go",
14-            "envFile": "${workspaceFolder}/.env",
15-            "cwd": "${workspaceFolder}"
16-        }
17-    ],
18-    "inputs": [
19-        {
20-            "id": "service",
21-            "type": "promptString",
22-            "description": "The service to debug",
23-            "default": "pgs"
24-        },
25-        {
26-            "id": "type",
27-            "type": "promptString",
28-            "description": "The service type to debug",
29-            "default": "ssh"
30-        }
31-    ]
32+  // Use IntelliSense to learn about possible attributes.
33+  // Hover to view descriptions of existing attributes.
34+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
35+  "version": "0.2.0",
36+  "configurations": [
37+    {
38+      "name": "Debug App",
39+      "type": "go",
40+      "request": "launch",
41+      "mode": "auto",
42+      "program": "${workspaceFolder}/cmd/${input:service}/${input:type}/main.go",
43+      "envFile": "${workspaceFolder}/.env",
44+      "cwd": "${workspaceFolder}"
45+    }
46+  ],
47+  "inputs": [
48+    {
49+      "id": "service",
50+      "type": "promptString",
51+      "description": "The service to debug",
52+      "default": "pgs"
53+    },
54+    {
55+      "id": "type",
56+      "type": "promptString",
57+      "description": "The service type to debug",
58+      "default": "ssh"
59+    }
60+  ]
61 }

 1@@ -1,24 +1,24 @@
 2 # pico.sh - hacker labs
 3 
 4-> [!IMPORTANT]
 5-> Read our docs at [pico.sh](https://pico.sh).
 6+> [!IMPORTANT] Read our docs at [pico.sh](https://pico.sh).
 7 
 8 Open source and managed services leveraging SSH.
 9 
10-The secret ingredient to all our services is how we let users
11-publish changes to their blog and sites without needing to install anything.
12-We accomplish this with what is colloquially termed SSH Apps. By using
13-the SSH protocol and golang's implementation of SSH, we can create
14-golang binaries that interface with SSH in unique ways.
15+The secret ingredient to all our services is how we let users publish content
16+without needing to install anything. We accomplish this with the SSH tools you
17+already have installed on your system.
18 
19-Want to publish a blog post? Use rsync, scp, or sftp.  Want to publish a
20-website?  Use rsync, scp, or sftp.  Want to share a code snippet with a
21-colleague?  Use rsync, scp, or sftp.  Hopefully you see the trend.
22+Want to publish a blog post? Use rsync, scp, or sftp. Want to publish a website?
23+Use rsync, scp, or sftp. Want to share a code snippet with a colleague? Use
24+rsync, scp, or sftp. Hopefully you see the trend
25 
26 - [pgs.sh](https://pico.sh/pgs): A static site hosting platform using SSH.
27-- [tuns.sh](https://pico.sh/tuns):  HTTP(S)/WS(S)/TCP Tunnels to localhost using only SSH.
28-- [imgs.sh](https://pico.sh/imgs): Docker image registry using SSH for authentication.
29-- [prose.sh](https://prose.sh): A blog platform using SSH for content management.
30+- [tuns.sh](https://pico.sh/tuns): HTTP(S)/WS(S)/TCP Tunnels to localhost using
31+  only SSH.
32+- [imgs.sh](https://pico.sh/imgs): Docker image registry using SSH for
33+  authentication.
34+- [prose.sh](https://prose.sh): A blog platform using SSH for content
35+  management.
36 - [pastes.sh](https://pastes.sh): Upload code snippets using SSH.
37 - [feeds.sh](https://feeds.sh): An RSS email notification system using SSH.
38 

 1@@ -34,7 +34,8 @@ make build
 2 
 3 All services are built inside the `./build` folder.
 4 
 5-If you want to start prose execute these binaries from the project root directory:
 6+If you want to start prose execute these binaries from the project root
 7+directory:
 8 
 9 ```bash
10 ./build/prose-web
11@@ -42,7 +43,6 @@ If you want to start prose execute these binaries from the project root director
12 ./build/prose-ssh
13 ```
14 
15-
16 ## deployment
17 
18 We use an image based deployment, so all of our images are uploaded to
19@@ -58,8 +58,8 @@ Once images are built, docker compose is used to stand up the services:
20 docker compose up -d
21 ```
22 
23-This makes use of a production `.env.prod` environment file which defines
24-the various listening addresses and services that will be started. For production,
25+This makes use of a production `.env.prod` environment file which defines the
26+various listening addresses and services that will be started. For production,
27 we add a `.envrc` containing the following:
28 
29 ```bash
30@@ -75,5 +75,5 @@ ln -s .env.prod .env
31 
32 This allows us to use docker-compose normally as we would in development.
33 
34-For any migrations, logging into the our database server, pulling the changes
35-to migrations and running `make latest` is all that is needed.
36+For any migrations, logging into the our database server, pulling the changes to
37+migrations and running `make latest` is all that is needed.