Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rss for shelves #113

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions content/contributing/install-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`. 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 }
Expand All @@ -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!

Expand Down
37 changes: 37 additions & 0 deletions content/using_bookwyrm/rss-feeds.md
Original file line number Diff line number Diff line change
@@ -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
Loading