From 2e4c0993f8b8a11706e1f04d690ab0229b737719 Mon Sep 17 00:00:00 2001 From: mattkatz Date: Mon, 25 Sep 2023 23:33:54 -0400 Subject: [PATCH 1/3] tell devs to note admin key,set USE_HTTPS=false Unless you've set yourself up for local https already, local https doesn't offer much for a new developer and lengthens the setup process. The admin key is also output on the command line and could be easily missed by someone who's pasted the commands. --- content/contributing/install-dev.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/contributing/install-dev.md b/content/contributing/install-dev.md index 8ccbe9f1..3dc037b4 100644 --- a/content/contributing/install-dev.md +++ b/content/contributing/install-dev.md @@ -18,6 +18,7 @@ cp .env.example .env ``` - In `.env`, change `DEBUG` to `true` - Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. +- Unless you want to set up your local machine to support https during development, you may want to set `USE_HTTPS=false` - Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: ``` { .sh } @@ -27,10 +28,10 @@ cp nginx/development nginx/default.conf - Start the application. In the command line, run: ``` { .sh } ./bw-dev build # Build the docker images -./bw-dev setup # Initialize the database and run migrations +./bw-dev setup # Initialize the database and run migrations. Note the ADMIN key at the end of this output. You'll need it to register the first admin user. ./bw-dev up # Start the docker containers ``` -- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/cli.html) for it, or open it up and look around to see exactly what each command is doing! From f3b2a27d95312157d023f79e4e53db1bdc42180a Mon Sep 17 00:00:00 2001 From: mattkatz Date: Mon, 25 Sep 2023 23:41:19 -0400 Subject: [PATCH 2/3] explain CSRF issue related to USE_HTTPS reasoning: people may blow past this and it's helpful to have something they can see explaining why they got an error and how to fix it. --- content/contributing/install-dev.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/contributing/install-dev.md b/content/contributing/install-dev.md index 3dc037b4..5b30a5a3 100644 --- a/content/contributing/install-dev.md +++ b/content/contributing/install-dev.md @@ -18,7 +18,7 @@ cp .env.example .env ``` - In `.env`, change `DEBUG` to `true` - Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. -- Unless you want to set up your local machine to support https during development, you may want to set `USE_HTTPS=false` +- Unless you want to set up your local machine to support https during development, you may want to set `USE_HTTPS=false`. If you try to register your admin account and see a message that `CSRF verification failed`, you should set this option. - Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: ``` { .sh } From 22ad523e06adbaa6a7ef3e93427cb88a69f61f5c Mon Sep 17 00:00:00 2001 From: mattkatz Date: Sat, 30 Sep 2023 17:35:43 -0400 Subject: [PATCH 3/3] document rss feed for shelves --- content/using_bookwyrm/rss-feeds.md | 37 +++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 content/using_bookwyrm/rss-feeds.md diff --git a/content/using_bookwyrm/rss-feeds.md b/content/using_bookwyrm/rss-feeds.md new file mode 100644 index 00000000..316135e1 --- /dev/null +++ b/content/using_bookwyrm/rss-feeds.md @@ -0,0 +1,37 @@ +--- +Title: RSS Feeds +Date: 2023-09-29 +Order: 3 +--- + +BookWyrm is an _open_ platform and generally it's ok to integrate your books and bookshelves in BookWyrm with other things. We provide some [RSS feeds](https://cyber.harvard.edu/rss/rss.html) to help you do that. + +## RSS Locations +Currently, all RSS Feeds are relative to a someone's profile on their BookWyrm instance. So if your profile is at https://bookwyrm.social/user/mouse then all the rss feeds will be at a URL based on that. + +### All Activity +This is everything someone posts that's publicly visible. + +You can see all the _public_ activity of a user at their profile url /rss. So for user profile http://bookwyrm.social/user/mouse you can get an rss feed of all activity at http://bookwyrm.social/user/mouse/rss + +BookWyrm is social - people quote books, chat with each other about books, etc. If you are looking for a more filtered view, the next locations might be useful. + +### Reviews +To get an RSS feed of every Review someone posts, add `/rss-reviews` to the end of their profile url. + +So for user profile http://bookwyrm.social/user/mouse you can get an rss feed of all Reviews at http://bookwyrm.social/user/mouse/rss-reviews + +### Quotes +To get a feed of every Quote someone posts, add `/rss-quotes` to the end of their profile url. + +So for user profile http://bookwyrm.social/user/mouse you can get an rss feed of all Quotes at http://bookwyrm.social/user/mouse/rss-quotes + +### Comments +To get a feed of every Comment someone posts, add `/rss-comments` to the end of their profile url. + +So for user profile http://bookwyrm.social/user/mouse you can get an rss feed of all Comments at http://bookwyrm.social/user/mouse/rss-comments + +### Shelves +You might also want to get a feed of books being added to someone's bookshelves. You'll add `/rss` to the end of that bookshelf's url. + +So for bookshelf https://bookwyrm.social/user/mouse/books/read you can get an RSS feed of all books added at https://bookwyrm.social/user/mouse/books/read/rss