Skip to content

Commit

Permalink
chore: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
neurosnap committed Apr 22, 2024
1 parent b26ca56 commit c9a1321
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 48 deletions.
58 changes: 29 additions & 29 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Debug App",
"type": "go",
"request": "launch",
"mode": "auto",
"program": "${workspaceFolder}/cmd/${input:service}/${input:type}/main.go",
"envFile": "${workspaceFolder}/.env",
"cwd": "${workspaceFolder}"
}
],
"inputs": [
{
"id": "service",
"type": "promptString",
"description": "The service to debug",
"default": "pgs"
},
{
"id": "type",
"type": "promptString",
"description": "The service type to debug",
"default": "ssh"
}
]
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Debug App",
"type": "go",
"request": "launch",
"mode": "auto",
"program": "${workspaceFolder}/cmd/${input:service}/${input:type}/main.go",
"envFile": "${workspaceFolder}/.env",
"cwd": "${workspaceFolder}"
}
],
"inputs": [
{
"id": "service",
"type": "promptString",
"description": "The service to debug",
"default": "pgs"
},
{
"id": "type",
"type": "promptString",
"description": "The service type to debug",
"default": "ssh"
}
]
}
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# pico.sh - hacker labs

> [!IMPORTANT]
> Read our docs at [pico.sh](https://pico.sh).
> [!IMPORTANT] Read our docs at [pico.sh](https://pico.sh).
Open source and managed services leveraging SSH.

The secret ingredient to all our services is how we let users
publish changes to their blog and sites without needing to install anything.
We accomplish this with what is colloquially termed SSH Apps. By using
the SSH protocol and golang's implementation of SSH, we can create
golang binaries that interface with SSH in unique ways.
The secret ingredient to all our services is how we let users publish content
without needing to install anything. We accomplish this with the SSH tools you
already have installed on your system.

Want to publish a blog post? Use rsync, scp, or sftp. Want to publish a
website? Use rsync, scp, or sftp. Want to share a code snippet with a
colleague? Use rsync, scp, or sftp. Hopefully you see the trend.
Want to publish a blog post? Use rsync, scp, or sftp. Want to publish a website?
Use rsync, scp, or sftp. Want to share a code snippet with a colleague? Use
rsync, scp, or sftp. Hopefully you see the trend

- [pgs.sh](https://pico.sh/pgs): A static site hosting platform using SSH.
- [tuns.sh](https://pico.sh/tuns): HTTP(S)/WS(S)/TCP Tunnels to localhost using only SSH.
- [imgs.sh](https://pico.sh/imgs): Docker image registry using SSH for authentication.
- [prose.sh](https://prose.sh): A blog platform using SSH for content management.
- [tuns.sh](https://pico.sh/tuns): HTTP(S)/WS(S)/TCP Tunnels to localhost using
only SSH.
- [imgs.sh](https://pico.sh/imgs): Docker image registry using SSH for
authentication.
- [prose.sh](https://prose.sh): A blog platform using SSH for content
management.
- [pastes.sh](https://pastes.sh): Upload code snippets using SSH.
- [feeds.sh](https://feeds.sh): An RSS email notification system using SSH.

Expand Down
12 changes: 6 additions & 6 deletions dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ make build

All services are built inside the `./build` folder.

If you want to start prose execute these binaries from the project root directory:
If you want to start prose execute these binaries from the project root
directory:

```bash
./build/prose-web
# in a separate terminal
./build/prose-ssh
```


## deployment

We use an image based deployment, so all of our images are uploaded to
Expand All @@ -58,8 +58,8 @@ Once images are built, docker compose is used to stand up the services:
docker compose up -d
```

This makes use of a production `.env.prod` environment file which defines
the various listening addresses and services that will be started. For production,
This makes use of a production `.env.prod` environment file which defines the
various listening addresses and services that will be started. For production,
we add a `.envrc` containing the following:

```bash
Expand All @@ -75,5 +75,5 @@ ln -s .env.prod .env

This allows us to use docker-compose normally as we would in development.

For any migrations, logging into the our database server, pulling the changes
to migrations and running `make latest` is all that is needed.
For any migrations, logging into the our database server, pulling the changes to
migrations and running `make latest` is all that is needed.

0 comments on commit c9a1321

Please sign in to comment.