Skip to content

Remove outdated information from readme #4

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Remove outdated information from readme #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# SkyFeed Indexer

ATProto/Bluesky Indexer, powered by [SurrealDB](https://github.com/surrealdb/surrealdb) and [Jetstream](https://github.com/bluesky-social/jetstream), written in [Rust](https://www.rust-lang.org/).

The indexer attaches a websocket to a Jetstream endpoint and converts all received events to SurrealDB queries. Temporary outtages are handled by the cursor system, which allows the indexer to resume indexing from the last known event.

The database can then be used to run powerful queries on the network data or build advanced custom feeds. All skyfeed.xyz feeds are powered by this service.

## Installation

1. Install the latest stable rust compiler from [rustup.rs](https://rustup.rs/).
2. Install either onto your system or into a docker container a [SurrealDB](https://surrealdb.com/docs/surrealdb/installation/running).
3. Generate a secure password, which may be generated using `openssl rand -base64 32` or `pwgen -s 32 1`.
4. Launch SurrealDB with the following flags: `surreal start --user root --pass <password here> --bind 127.0.0.1:8000 <dbtype>:<dbfile>`.
5. Clone the repository and run `cargo build --release`.
6. Launch the indexer with `./target/release/skyfeed-indexer [--help]`.
3. Clone the repository and run `cargo build --release`.
4. Launch the indexer with `./target/release/skyfeed-indexer [--help]`.

You may need to increase the ulimit for the number of open files. You can do this by running `ulimit -n 1000000`.