tom.sherman.is
A fork of https://github.com/teal-fm/piper
Update readme
+10
-9
README.md
+10
-9
README.md
···
1
+
A fork of https://github.com/teal-fm/piper
2
+
1
3
# piper
2
4
3
5
#### what is piper?
···
10
12
well its just a work in progress... we build in the open!
11
13
12
14
## setup
15
+
13
16
It is recommend to have port forward url while working with piper. Development or running from docker because of external callbacks.
14
17
15
18
You have a couple of options
19
+
16
20
1. Setup the traditional port forward on your router
17
21
2. Use a tool like [ngrok](https://ngrok.com/) with the command `ngrok http 8080` or [Cloudflare tunnels](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/) (follow the 2a. portion of the guide when you get to that point)
18
22
19
23
Either way make note of what the publicly accessible domain name is for setting up env variables. It will be something like `https://piper.teal.fm` that you can access publicly
20
24
21
25
#### env variables
26
+
22
27
Copy [.env.template](.env.template) and name it [.env](.env)
23
28
24
29
This is a break down of what each env variable is and what it may look like
···
30
35
- `ATPROTO_CLIENT_SECRET_KEY` - Private key for oauth confidential client. This can be generated via goat `goat key generate -t P-256`
31
36
- `ATPROTO_CLIENT_SECRET_KEY_ID` - Key ID for oauth confidential client. This needs to be persistent and unique, can use a timestamp. Here's one for you: `1758199756`
32
37
33
-
34
38
- `SERVER_PORT` - The port piper is hosted on
35
39
- `SERVER_HOST` - The server host. `localhost` is fine here, or `0.0.0.0` for docker
36
40
- `SERVER_ROOT_URL` - This needs to be the pubically accessible url created in [Setup](#setup). Like `https://piper.teal.fm`
···
49
53
50
54
- `TRACKER_INTERVAL` - How long between checks to see if the registered users are listening to new music
51
55
- `DB_PATH`= Path for the sqlite db. If you are using the docker compose probably want `/db/piper.db` to persist data
52
-
53
-
54
56
55
57
## development
56
58
···
76
78
```
77
79
air
78
80
```
79
-
air should automatically build and run piper, and watch for changes on relevant files.
80
81
82
+
air should automatically build and run piper, and watch for changes on relevant files.
81
83
82
84
## tailwindcss
83
85
84
-
To use tailwindcss you will have to install the tailwindcss cli. This will take the [./pages/static/base.css](./pages/static/base.css) and transform it into a [./pages/static/main.css](./pages/static/main.css)
86
+
To use tailwindcss you will have to install the tailwindcss cli. This will take the [./pages/static/base.css](./pages/static/base.css) and transform it into a [./pages/static/main.css](./pages/static/main.css)
85
87
which is imported on the [./pages/templates/layouts/base.gohtml](./pages/templates/layouts/base.gohtml). When running the dev server tailwindcss will watch for changes and recompile the main.css file.
86
88
87
89
1. Install tailwindcss cli `npm install tailwindcss @tailwindcss/cli`
88
90
2. run `npx @tailwindcss/cli -i ./pages/static/base.css -o ./pages/static/main.css --watch`
89
91
90
-
91
-
92
+
#### Lexicon changes
92
93
93
-
#### Lexicon changes
94
94
1. Copy the new or changed json schema files to the [lexicon folders](./lexicons)
95
95
2. run `make go-lexicons`
96
96
97
-
Go types should be updated and should have the changes to the schemas
97
+
Go types should be updated and should have the changes to the schemas
98
98
99
99
#### docker
100
+
100
101
We also provide a docker compose file to use to run piper locally. There are a few edits to the [.env](.env) to make it run smoother in a container
101
102
`SERVER_HOST`- `0.0.0.0`
102
103
`DB_PATH` = `/db/piper.db` to persist your piper db through container restarts