diff --git a/README.md b/README.md index 3eddbef..8c152c9 100644 --- a/README.md +++ b/README.md @@ -59,22 +59,31 @@ If running in docker, this means you run This project doesn't crawl personal instances: the goal is to understand communities, not individuals. The threshold for what makes an instance "personal" is defined in the [backend config](backend/config/config.exs) and the [graph builder SQL](gephi/src/main/java/space/fediverse/graph/GraphBuilder.java). ## Deployment + You don't have to follow these instructions, but it's one way to set up a continuous deployment pipeline. The following are for the backend; the frontend is just a static HTML/JS site that can be deployed anywhere. + 1. Install [Dokku](http://dokku.viewdocs.io/dokku/) on your web server. 2. Install [dokku-postgres](https://github.com/dokku/dokku-postgres), [dokku-monorepo](https://github.com/notpushkin/dokku-monorepo), and [dokku-letsencrypt](https://github.com/dokku/dokku-letsencrypt). 3. Create the apps - * `dokku apps:create phoenix` - * `dokku apps:create gephi` + +- `dokku apps:create phoenix` +- `dokku apps:create gephi` + 4. Create the backing database - * `dokku postgres:create fediversedb` - * `dokku postgres:link fediversedb phoenix` - * `dokku postgres:link fediversedb gephi` + +- `dokku postgres:create fediversedb` +- `dokku postgres:link fediversedb phoenix` +- `dokku postgres:link fediversedb gephi` + 5. Update the backend configuration. In particular, change the `user_agent` in [config.exs](/backend/config/config.exs) to something descriptive. 6. Push the apps, e.g. `git push dokku@:phoenix` (note that the first push cannot be from the CD pipeline). 7. Set up SSL for the Phoenix app - * `dokku letsencrypt phoenix` - * `dokku letsencrypt:cron-job --add` + +- `dokku letsencrypt phoenix` +- `dokku letsencrypt:cron-job --add` + 8. Set up a cron job for the graph layout (use the `dokku` user). E.g. + ``` SHELL=/bin/bash 0 2 * * * /usr/bin/dokku run gephi java -Xmx1g -jar build/libs/graphBuilder.jar @@ -82,6 +91,6 @@ SHELL=/bin/bash ## Acknowledgements -[![NLnet logo](https://i.imgur.com/huV3rvo.png)](https://nlnet.nl/project/fediverse_space/) +[![NLnet logo](/nlnet-logo.png)](https://nlnet.nl/project/fediverse_space/) Many thanks to [NLnet](https://nlnet.nl/project/fediverse_space/) for their support and guidance of this project. diff --git a/frontend/src/assets/nlnet.png b/frontend/src/assets/nlnet.png new file mode 100644 index 0000000..27fad98 Binary files /dev/null and b/frontend/src/assets/nlnet.png differ diff --git a/frontend/src/components/screens/AboutScreen.tsx b/frontend/src/components/screens/AboutScreen.tsx index 6afdbf3..ef2e6cb 100644 --- a/frontend/src/components/screens/AboutScreen.tsx +++ b/frontend/src/components/screens/AboutScreen.tsx @@ -1,5 +1,6 @@ import { Classes, Code, H1, H2, H4 } from "@blueprintjs/core"; import * as React from "react"; +import nlnetLogo from "../../assets/nlnet.png"; import { Page } from "../atoms/"; const AboutScreen: React.FC = () => ( @@ -33,24 +34,32 @@ const AboutScreen: React.FC = () => (

How do I add my personal instance?

-

- Send a DM to{" "} - - @fediversespace - {" "} - on Mastodon. Make sure to send it from the account that's listed as the instance admin. -

+

Click on the Administration link in the top right to opt-in.

How do you calculate the strength of relationships between instances?

- fediverse.space scrapes the last 5000 statuses from within the last month on the public timeline of each instance. - It looks at the ratio of + fediverse.space looks at statuses from within the last month on the public timeline of each instance. It + calculates at the ratio of mentions of an instance / total statuses. It uses a ratio rather than an absolute number of mentions to reflect that smaller instances can play a large role in a community.

Credits

-

This site is inspired by several other sites in the same vein:

+ + + NLnet logo + +
+
+

+ This project is proudly supported by{" "} + + NLnet + + . +

+ +

Inspiration for this site comes from several places: