fedipage/README.md

2.2 KiB

Generate Activity Pub key

npm install ts-node typescript '@types/node'
./node_modules/.bin/ts-node --esm generateKeys.mts

Setup firebase

Setup the things

Setup Vercel

Setup the things

Trigger post deploy

curl -G -X POST --data-urlencode token="<token>" https://flear.org/send-note

License

This project (excluding post content itself) is released under the Apache License v2

Notes to reconcile later

  • Set configuration in /hugo.toml (defaults are in /config/* dont touch)
  • Set Gitlab CI ENV variables: ** VERCEL_ORG_ID ** VERCEL_PROJECT_ID ** VERCEL_TOKEN (mask this and make it availible to only protected) ** VERCEL_SCOPE (set to vercel team id, find with vercel team ls after creating)
  • Set vercel environment variables (vercel.com > project > Settings > Environment Variables) (set on production only usually) ** POLL_MILLISECONDS (set to 250000 or higher) ** ACTIVITYPUB_PRIVATE_KEY (get this value from generating the keys in the pervious step) ** ACTIVITYPUB_PUBLIC_KEY (get this value from generating the keys in the pervious step) ** FIREBASE_PRIVATE_KEY ** FIREBASE_CLIENT_EMAIL ** NEXT_PUBLIC_FIREBASE_PROJECT_ID ** ACTIVITYPUB_URL ** ACTIVITYPUB_USER ** ACTIVITYPUB_ALIAS (optional) ** ACTIVITYPUB_NAME ** ACTIVITYPUB_SUMMARY
  • Modify /layouts/partials/top_list_* to represent the section titles you want to use.
  • Update package.json ** Update name field ** update description field
  • Update manifest.json ** name ** short_name ** description
  • Update robots.txt to point to the full URL of this site
  • Modify vercel.json ** Find the line where source is set to "/flear" and update it to point to your apUser name (all lowercase even if variable has case).
  • Go through the /api and manually change references (this step will either be explained later or not needed soon, just a reminder placeholder)

The above steps might be reduced by using template processing on otherwise unprocessed files (normally not part of hugo). See the following for more info https://vercel.com/docs/functions/serverless-functions/runtimes/node-js NOTE: Once we move the project over to a dedicated git, change the node info under api and track the version NOTE: And the source link in the footer NOTE: And package.json