jekyll-activitypub-static 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474e7a72176ed92f873aa65bcee1b79b1069ec2e124a23fee429741a81bc00e2
-  data.tar.gz: 136fee10239aa4da8c286c03643dd1b17ef315997690f7a6c10d05b1750f94ca
+  metadata.gz: ecce07ba2b46d11a685b972da716ab71581b3cf3ed8223a997fb41b91dbcb446
+  data.tar.gz: c55f977f3f7c80cef6f3a2ff3de2b3fd87dd5ea81b9ad19d5b3e0f00c33fcf2f
 SHA512:
-  metadata.gz: 2367a4b0f89526bc5af938b3abe372398c3bae8d6a5766ee4ffca8eccb029884fd35bb34a0a0a6683a1fe8d9ca8cd13ead5f7c5c27d57b4f60b101cfcf768734
-  data.tar.gz: acc055a65f78b0fda9f9d35d800baebe4a4c0d2f1094fe93cb29ac829ba7f51d62633f076096ca052f66fc2b352546b4c3f994e37240ae72c3152e5aaf5610a7
+  metadata.gz: 9a1f8a02496607d0da688d196bff71a7f34e562b1aed6371490d332a8649c18e67b9b25891cc29b98d0fc52b5b1bc0ecef448574a771dc18ab241218545be1ef
+  data.tar.gz: 47c31eb9a5f1b3f79255b679ec259d4b67540b0630b68de76099595905f4b167dbb0cc51ca031cb9e5d030a930716c00c78befa910ae284e07e631e187fd1842

data/README.md

@@ -2,7 +2,20 @@
 
 A Jekyll plugin that generates a static ActivityPoll feed, the read-only polling subset of ActivityPub defined by FEP-b06c.
 
-## Installation
+## Table of Contents
+
+- [Install](#install)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Articles and Notes](#articles-and-notes)
+- [Layouts](#layouts)
+- [Generated Files](#generated-files)
+- [GitHub Pages](#github-pages)
+- [Example Site](#example-site)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Install
 
 Add this to the `Gemfile` of your Jekyll site:
 
@@ -17,15 +30,27 @@ gem build jekyll-activitypub-static.gemspec
 gem install ./jekyll-activitypub-static-*.gem
 ```
 
-## Usage
-
-Add this to the `_config.yml` for your site:
+Add the plugin to the `_config.yml` for your site:
 
 ```yaml
 plugins:
   - jekyll-activitypub-static
 ```
 
+## Usage
+
+Build your site to generate the ActivityPub files:
+
+```sh
+bundle exec jekyll build
+```
+
+To build the site and serve it locally:
+
+```sh
+bundle exec jekyll serve
+```
+
 ## Configuration
 
 The plugin uses your site's standard `url`, `author`, and `description`
@@ -42,6 +67,7 @@ activitypub:
   summary_property: "description"
   note_max_characters: 500
   update_interval: "P1D"
+  webfinger_output_file: ".well-known/webfinger"
 ```
 
 Available `activitypub` options:
@@ -58,6 +84,9 @@ Available `activitypub` options:
   Note objects. Defaults to `500`.
 - `update_interval`: ActivityPoll polling interval for the generated Actor
   object, as an ISO 8601 duration. Defaults to `P1D`.
+- `webfinger_output_file`: path for the generated WebFinger document. Defaults
+  to `.well-known/webfinger`. GitHub Pages sites can set this to
+  `.well-known/webfinger/index.json` as a workaround for its content type.
 
 ## Articles and Notes
 
@@ -114,16 +143,53 @@ The `activitypub` path changes when `activitypub.output_path` is configured.
 
 ### WebFinger
 
-The WebFinger document is generated at `.well-known/webfinger` and uses an
-account ID in the form `preferred_username` at the site domain. For example,
-with `url: "https://example.com"` and `preferred_username: "evan"`, the
-account ID is `evan@example.com`.
+The WebFinger document is generated at `.well-known/webfinger` by default and
+uses an account ID in the form `preferred_username` at the site domain. For
+example, with `url: "https://example.com"` and `preferred_username: "evan"`,
+the account ID is `evan@example.com`.
+
+The output path can be configured with `activitypub.webfinger_output_file`.
+For example, GitHub Pages sites can use the following workaround to serve the
+document through an `index.json` file:
+
+```yaml
+activitypub:
+  webfinger_output_file: ".well-known/webfinger/index.json"
+```
+
+GitHub Pages redirects requests for `.well-known/webfinger` to
+`.well-known/webfinger/`, where it serves `index.json`.
 
 WebFinger discovery only works when the generated site is served from the root
 of its domain, because clients request `https://example.com/.well-known/webfinger`.
 Sites served from a subdirectory cannot provide a domain-level WebFinger
 endpoint with this plugin alone.
 
+## GitHub Pages
+
+GitHub Pages' built-in Jekyll build does not support this plugin because it is
+not on GitHub's allowlist. Configure a GitHub Actions workflow to build the
+site instead.
+
+The `.well-known` directory can be dropped when uploading the resulting site to GitHub Pages. To work around this, set `include-hidden-files: true` on the `actions/upload-pages-artifact` step in the GitHub Actions workflow:
+
+```yaml
+- uses: actions/upload-pages-artifact@v5
+  with:
+    path: _site
+    include-hidden-files: true
+```
+
+Configure WebFinger to use an `index.json` file:
+
+```yaml
+activitypub:
+  webfinger_output_file: ".well-known/webfinger/index.json"
+```
+
+The `index.json` path works around GitHub Pages serving the extensionless
+`.well-known/webfinger` file with an `application/octet-stream` content type.
+
 ## Example Site
 
 The `example-site` directory has a minimal example site (thus the name). You can build and run it with these commands:
@@ -137,6 +203,16 @@ bundle exec jekyll serve
 
 This will build a site that runs on `http://localhost:4000/`
 
+## Viewing from the Fediverse
+
+Support for interacting with static accounts on the Fediverse is still experimental; most software will not allow full interactions.
+
+With Mastodon 4.x (the current version) you can search for the account by Webfinger ID (username@domain), and then load the account. It should show the profile information.
+
+With [Webfinger Browser](https://acct.swf.pub/), you can search for the account by Webfinger ID, and view the account. It should show the profile information and all the generated content.
+
+It's still definitely worthwhile to keep this plugin enabled; it gives an incentive for Fediverse software developers to add support for static accounts.
+
 ## Contributing
 
 PRs accepted.

data/lib/jekyll/activitypub_static/generator.rb

@@ -33,7 +33,7 @@ module Jekyll
       end
 
       def generate_webfinger(site)
-        Jekyll.logger.info LOG_TAG, "Generating .well-known/webfinger"
+        Jekyll.logger.info LOG_TAG, "Generating webfinger endpoint"
 
         url = site.config["url"]
         actor_url = "#{url}/actor.jsonld"
@@ -49,7 +49,10 @@ module Jekyll
           ]
         }
 
-        sf = JsonStaticFile.new(site, ".well-known", "webfinger", webfinger)
+        webfinger_output_file = site.config.dig("activitypub", "webfinger_output_file") || ".well-known/webfinger"
+
+        sf = JsonStaticFile.new(site, File.dirname(webfinger_output_file), File.basename(webfinger_output_file),
+                                webfinger)
         site.static_files << sf
 
         Jekyll.logger.info LOG_TAG, "Added webfinger as #{sf.path}"

data/lib/jekyll/activitypub_static/version.rb

@@ -1,6 +1,6 @@
 # lib/jekyll/activitypub_static/version.rb
 module Jekyll
   module ActivityPubStatic
-    VERSION = "0.9.0"
+    VERSION = "0.10.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-activitypub-static
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Evan Prodromou