diff --git a/main b/main deleted file mode 100755 index 27bf89420531c43c8d612438ffbd0b54542209f8..0000000000000000000000000000000000000000 Binary files a/main and /dev/null differ diff --git a/readme.md b/readme.md index b868b5c..df3432a 100644 --- a/readme.md +++ b/readme.md @@ -14,12 +14,12 @@ TLDR of what this app does if you haven't read the [ATProto application Statusph A few environment variables are required to run the app. Use the `example.env` file as a template and store your environment variables in a `.env` file. -* PRIVATEJWKS: This is a private JWKS. You can generate one using the same Go OAuth [library](https://github.com/haileyok/atproto-oauth-golang). +* PRIVATEJWKS: This is a private JWKS. You can generate one using the same Go OAuth [library](https://github.com/haileyok/atproto-oauth-golang). Once created, base64 encode it so it's easier to store in your env. * SESSION_KEY: This can be anything as it's what's used to encrypt session data sent to/from the client. * HOST: This needs to be a http URL where the server is running. For local dev I suggest using something like [ngrok](https://ngrok.com) to run you app locally and make it accessable externally. This is important for OAuth as the callback URL configured needs to be a publically accessable. * DATABASE_MOUNT_PATH: This is where you wish the mysql database to be located. -Run the command `go build -o statuspherego ./cmd/statuspherego/main.go` which will build the app and then `./statuspherego` to run it. +Run the command `go build -o statuspherego ./cmd/main.go` which will build the app and then `./statuspherego` to run it. If running locally I would then run `ngrok http http://localhost:8080` to get your publically accessable URL. -- knotmirror 0.0.1 From cf5446683a4c36158bdf2a68aad970925cbf603c Mon Sep 17 00:00:00 2001 From: Will Andrews Date: Fri, 9 May 2025 19:42:32 +0100 Subject: [PATCH 2/2] update readme again --- readme.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index df3432a..049967e 100644 --- a/readme.md +++ b/readme.md @@ -4,10 +4,13 @@ This is an implementation of the example [ATProto application Statusphere](https It makes use of an ATProto OAuth [library](https://github.com/haileyok/atproto-oauth-golang). Shout out to [Hailey](https://bsky.app/profile/hailey.at) for implementing a Go OAuth library! -TLDR of what this app does if you haven't read the [ATProto application Statusphere](https://atproto.com/guides/applications) guide. +### What is the Statusphere app? +If you haven't read the [ATProto application Statusphere](https://atproto.com/guides/applications) guide about what this is, here is a quick summary. 1: Allows you to log into Bluesky using OAuth. + 2: Allows you to post a status (an emoji) which creates a record in your PDS. + 3: Shows other users status' when they do the same, even if they are using a different app that this. As long as they are using the statusphere lexicon and NSID then this application will consume those records using Jetstream (firehose) and store them in the local database. ### Running the app