You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,23 +22,27 @@ Operates completely in browser, except for [GitHub token exchange](https://githu
22
22
To run your own instance of Habbitses you'll need several things:
23
23
24
24
- GitHub code exchange server, you can use or fork [mine](https://github.com/roboslone/github-oauth-exchange) or write your own supporting the same [protocol](https://buf.build/roboslone-oauth/github)
25
-
- your server address patched into [`ExchangeClient`](https://github.com/roboslone/habbitses/blob/main/src/lib/queries.ts#L20)
26
-
- GitHub pages enabled for your repo, pushed to `main` branch are published with [GitHub workflow](https://github.com/roboslone/habbitses/blob/main/.github/workflows/deploy.yml)
25
+
- your server address and GitHub application client ID patched into `src/lib/const.ts`
26
+
- GitHub pages enabled for your repo, pushes to `main` branch are published with [GitHub workflow](https://github.com/roboslone/habbitses/blob/main/.github/workflows/deploy.yml)
27
27
28
28
If you're using my exchange server, don't forget to put it behind TLS termination proxy (e.g. `nginx`) and set up CORS to allow your domain(s).
29
29
30
30
## GitHub rate limits
31
+
31
32
All requests within Habbitses will count towards your [API rate limits](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api).
32
33
At the time of writing limit is 15 000 requests per hour, so this should not be a problem.
33
34
34
35
## Security and privacy
35
-
Code exchange server **will have access** to your access and refresh tokens.
36
-
So you should only install Habbitses to a single repository containing your habit data.
36
+
37
+
Code exchange server **will have access** to your access and refresh tokens.
38
+
39
+
So you should only install Habbitses to a single repository containing your habit data.
37
40
38
41
App doesn't have any trackers (other than for your habits, duh) or ads and doesn't collect any data.
39
-
However, it's technically possible for exchange server administrator to use your access token to read your repository contents and therefore your habit data, including broken habits (via git logs).
42
+
However, it's technically possible for exchange server administrator to use your access token to read your repository contents and therefore your habit data, including broken habits (via git logs).
0 commit comments