Skip to content

Latest commit

 

History

History
45 lines (39 loc) · 2.76 KB

README.md

File metadata and controls

45 lines (39 loc) · 2.76 KB

This site and its associated services is hosted on Nearly Free Speech

Here I'll document how I've set things up for posterity

This documentation is accurate as of it's last check on: 2023-01-28

Bootstrapping the website

  • Fork this repository
  • Generate an ssh key ssh-keygen -t ed25519 -C "<some-email>"
  • Create a new site on NFSN
  • Create two Github Action secrets
    1. SSH_KEY: <your public key>
    2. KNOWN_HOSTS: NearlyFreeSpeech's ssh fingerprints
  • Next time you commit to the main branch the github actions will build and deploy your site to NFSN

To setup analytics for this site:

  • Run make bootstrap-analytics to setup awstats on NFSN
  • Setup a scheduled task to run /home/protected/updateAnalytics.sh however often you like.
  • Your analytics will be availiable at https://<your-website>/analytics/

To setup go-jamming webmentions for this site:

  • Ensure you're on a server-type which allows for daemons
  • ssh into the site and follow go-jamming's (simple!) steps to build and configure
    • This faq should help you understand which folder to build in 😉
    • You can validate that it's working by running ./go-jamming &1 then curl localhost:<port>/webmention/<domain>/<token>2 3. If you don't get a 404 it's working
  • Setup a daemon to run go-jamming with these parameters:
    • tag: <whatever you want>
    • Command Line: <install directory>/go-jamming 4
    • Working Directory: <install directory>
    • Run Daemon As: me
  • Setup a proxy with these parameters:
    • Protocol: http
    • Base URI: linkback
    • Document Root: /
    • Target Port: <the port from your config>
  • go-jamming is now setup and ready to use.5
  • Create a Github Action secret
    • WEBMENTIONS_URL: <your url>/webmention//

Footnotes

  1. make sure to kill this background process when you're done or your daemon will fail to start ↩

  2. port, domain, and token are all values found in go-jamming's config.json ↩

  3. your token should remain secret, please don't commit it ↩

  4. If you search the NFSN FAQ for docs on daemons it'll recommend you create a run script, but since go-jamming didn't require any arguments for my setup this was unnessesary ↩

  5. go-jamming's usage documentation is pretty complete ↩