rsky
An AT Protocol implementation prioritizing community safety and self-governance, written in Rust.
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- determine-dockerfiles.sh
- determine-workspace-members.sh
- rsky-pdsadmin.yml
- rust.yml
- tangle.yml
- CODE_OF_CONDUCT.md
- FUNDING.yml
- pull_request_template.md
- Project_Default.xml
- .gitignore
- misc.xml
- modules.xml
- sqldialects.xml
- vcs.xml
- addMember.json
- checkUserAccess.json
- createSpace.json
- defs.json
- deleteSpace.json
- listMembers.json
- removeMember.json
- updateSpace.json
- applyWrites.json
- createRecord.json
- defs.json
- deleteRecord.json
- getBlob.json
- getDelegationToken.json
- getLatestCommit.json
- getRecord.json
- getRepo.json
- getSpace.json
- getSpaceCredential.json
- listBlobs.json
- listRecords.json
- listRepoOps.json
- listRepos.json
- listSpaces.json
- notifySpaceDeleted.json
- notifyWrite.json
- putRecord.json
- registerNotify.json
- unregisterNotify.json
- main.rs
- Cargo.toml
- async.rs
- env.rs
- explicit_slurs.rs
- ipld.rs
- lib.rs
- sign.rs
- tid.rs
- time.rs
- Cargo.toml
- README.md
- encoding.rs
- mod.rs
- operations.rs
- plugin.rs
- encoding.rs
- mod.rs
- operations.rs
- plugin.rs
- constants.rs
- did.rs
- lib.rs
- multibase.rs
- types.rs
- utils.rs
- verify.rs
- Cargo.toml
- README.md
- config.rs
- credentials.rs
- dpop.rs
- engine.rs
- error.rs
- index.rs
- lib.rs
- main.rs
- notify.rs
- recovery.rs
- repohost.rs
- runner.rs
- sqlite_index.rs
- xrpc.rs
- Cargo.toml
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- .diesel_lock
- .keep
- mod.rs
- mod.rs
- algo_response.rs
- banned_from_tv.rs
- banned_from_tv_request.rs
- create_request.rs
- delete_request.rs
- error_code.rs
- internal_error_code.rs
- internal_error_message_response.rs
- jwt_parts.rs
- known_service.rs
- membership.rs
- mod.rs
- not_found_error_code.rs
- path_unknown_error_message_response.rs
- post.rs
- post_result.rs
- sub_state.rs
- validation_error_message_response.rs
- well_known.rs
- auth.rs
- lib.rs
- main.rs
- routes.rs
- schema.rs
- Cargo.toml
- diesel.toml
- Dockerfile
- README.md
- create_op.rs
- delete_op.rs
- mod.rs
- car.rs
- firehose.rs
- lib.rs
- main.rs
- Cargo.toml
- Dockerfile
- README.md
- mod.rs
- atproto_data.rs
- did_resolver.rs
- mod.rs
- plc_resolver.rs
- web_resolver.rs
- mod.rs
- errors.rs
- lib.rs
- types.rs
- Cargo.toml
- README.md
- create_op.rs
- delete_op.rs
- mod.rs
- jetstream.rs
- lib.rs
- main.rs
- Cargo.toml
- Dockerfile
- README.md
- car.rs
- firehose.rs
- lib.rs
- main.rs
- Cargo.toml
- Dockerfile
- README.md
- external.rs
- images.rs
- mod.rs
- record.rs
- record_with_media.rs
- video.rs
- like.rs
- mod.rs
- follow.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- actor.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- admin.rs
- identity.rs
- mod.rs
- moderation.rs
- repo.rs
- server.rs
- simplespace.rs
- space.rs
- sync.rs
- temp.rs
- mod.rs
- atproto_bytes.rs
- blob_refs.rs
- lib.rs
- Cargo.toml
- README.md
- client.rs
- dpop.rs
- error.rs
- jwk.rs
- jwt.rs
- lib.rs
- provider.rs
- request.rs
- store.rs
- token.rs
- types.rs
- Cargo.toml
- account.rs
- auth.rs
- email_token.rs
- invite.rs
- mod.rs
- password.rs
- repo.rs
- db.rs
- mod.rs
- oauth_store.rs
- tests.rs
- mod.rs
- s3.rs
- mod.rs
- mod.rs
- mod.rs
- util.rs
- mod.rs
- mod.rs
- sql_repo.rs
- types.rs
- commit.rs
- mod.rs
- tests.rs
- blobstore.rs
- disk_blobstore.rs
- mod.rs
- tests.rs
- get_preferences.rs
- get_profile.rs
- get_profiles.rs
- mod.rs
- put_preferences.rs
- get_actor_likes.rs
- get_author_feed.rs
- get_feed.rs
- get_post_thread.rs
- get_timeline.rs
- mod.rs
- mod.rs
- register_push.rs
- unregister_push.rs
- mod.rs
- mod.rs
- mod.rs
- delete_account.rs
- disable_account_invites.rs
- disable_invite_codes.rs
- enable_account_invites.rs
- get_account_info.rs
- get_account_infos.rs
- get_invite_codes.rs
- get_subject_status.rs
- mod.rs
- send_email.rs
- update_account_email.rs
- update_account_handle.rs
- update_account_password.rs
- update_subject_status.rs
- get_recommended_did_credentials.rs
- mod.rs
- refresh_identity.rs
- request_plc_operation_signature.rs
- resolve_did.rs
- resolve_handle.rs
- resolve_identity.rs
- sign_plc_operation.rs
- submit_plc_operation.rs
- update_handle.rs
- create_report.rs
- mod.rs
- apply_writes.rs
- create_record.rs
- delete_record.rs
- describe_repo.rs
- get_record.rs
- import_repo.rs
- list_missing_blobs.rs
- list_records.rs
- mod.rs
- put_record.rs
- upload_blob.rs
- activate_account.rs
- check_account_status.rs
- confirm_email.rs
- create_account.rs
- create_app_password.rs
- create_invite_code.rs
- create_invite_codes.rs
- create_session.rs
- deactivate_account.rs
- delete_account.rs
- delete_session.rs
- describe_server.rs
- get_account_invite_codes.rs
- get_service_auth.rs
- get_session.rs
- list_app_passwords.rs
- mod.rs
- refresh_session.rs
- request_account_delete.rs
- request_email_confirmation.rs
- request_email_update.rs
- request_password_reset.rs
- reserve_signing_key.rs
- reset_password.rs
- revoke_app_password.rs
- update_email.rs
- add_member.rs
- create_space.rs
- delete_space.rs
- list_members.rs
- mod.rs
- remove_member.rs
- update_space.rs
- apply_writes.rs
- create_record.rs
- delete_record.rs
- get_blob.rs
- get_delegation_token.rs
- get_latest_commit.rs
- get_record.rs
- get_repo.rs
- get_repo_state.rs
- get_space.rs
- get_space_credential.rs
- host.rs
- list_blobs.rs
- list_records.rs
- list_repo_ops.rs
- list_repos.rs
- list_spaces.rs
- mod.rs
- notify_space_deleted.rs
- notify_write.rs
- put_record.rs
- register_notify.rs
- unregister_notify.rs
- get_blob.rs
- get_blocks.rs
- get_checkout.rs
- get_head.rs
- get_latest_commit.rs
- get_record.rs
- get_repo.rs
- get_repo_status.rs
- list_blobs.rs
- list_repos.rs
- mod.rs
- subscribe_repos.rs
- check_signup_queue.rs
- mod.rs
- mod.rs
- mod.rs
- describe.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- migrator.rs
- mod.rs
- pagination.rs
- sqlite.rs
- errors.rs
- explicit_slurs.rs
- mod.rs
- reserved.rs
- mod.rs
- lexicons.rs
- lexicons.toml
- mod.rs
- mod.rs
- moderation.rs
- error_code.rs
- error_message_response.rs
- mod.rs
- models.rs
- server_version.rs
- fetcher.rs
- mod.rs
- routes.rs
- templates.rs
- mod.rs
- operations.rs
- types.rs
- mod.rs
- tests.rs
- types.rs
- util.rs
- viewer.rs
- mod.rs
- prepare.rs
- db.rs
- events.rs
- mod.rs
- outbox.rs
- tests.rs
- frames.rs
- mod.rs
- types.rs
- auth.rs
- mod.rs
- types.rs
- auth_verifier.rs
- background.rs
- context.rs
- crawlers.rs
- did_cache.rs
- lib.rs
- main.rs
- oauth_scope.rs
- permission_set.rs
- pipethrough.rs
- space_auth.rs
- space_scope.rs
- well_known.rs
- oauth_base_style.html
- oauth_consent.html
- oauth_error.html
- oauth_signin.html
- mod.rs
- expired_token_tests.rs
- integration_tests.rs
- oauth_tests.rs
- service_describe_tests.rs
- space_integration_tests.rs
- space_oplog_window_test.rs
- Cargo.toml
- Dockerfile
- README.md
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- env.rs
- http_client.rs
- mod.rs
- lib.rs
- main.rs
- external_commands_tests.rs
- file_tests.rs
- integration_tests.rs
- Cargo.toml
- pds.env
- README.md
- client.rs
- connection.rs
- manager.rs
- mod.rs
- types.rs
- worker.rs
- connection.rs
- manager.rs
- mod.rs
- types.rs
- worker.rs
- mod.rs
- server.rs
- types.rs
- event.rs
- manager.rs
- mod.rs
- resolver.rs
- types.rs
- utils.rs
- config.rs
- lib.rs
- main.rs
- metrics.rs
- types.rs
- .python-version
- Cargo.toml
- crawler.py
- main.py
- pyproject.toml
- README.md
- rustfmt.toml
- ssl.sh
- uv.lock
- valid_repo.car
- diff.rs
- mod.rs
- util.rs
- walker.rs
- memory_blockstore.rs
- mod.rs
- readable_blockstore.rs
- sync_storage.rs
- types.rs
- consumer.rs
- mod.rs
- provider.rs
- block_map.rs
- car.rs
- cid_set.rs
- data_diff.rs
- error.rs
- lib.rs
- parse.rs
- readable_repo.rs
- repo.rs
- types.rs
- util.rs
- interop.rs
- interop_src
- Cargo.toml
- README.md
- favicon.ico
- header.svg
- main.css
- tailwind.css
- hero.rs
- mod.rs
- main.rs
- .gitignore
- Cargo.toml
- Dioxus.toml
- input.css
- package-lock.json
- package.json
- README.md
- tailwind.config.js
- car.rs
- commit.rs
- credential.rs
- error.rs
- jwk.rs
- lib.rs
- lthash.rs
- space_id.rs
- types.rs
- Cargo.toml
- README.md
- appaccess.rs
- attestation.rs
- authority.rs
- config.rs
- error.rs
- http.rs
- keys.rs
- lib.rs
- main.rs
- managing_app.rs
- membership.rs
- notify.rs
- policy.rs
- service_jwt.rs
- signing.rs
- store.rs
- Cargo.toml
- aturi.rs
- aturi_validation.rs
- datetime.rs
- did.rs
- handle.rs
- lib.rs
- nsid.rs
- record_key.rs
- tid.rs
- ATURI_VALIDATION.md
- Cargo.toml
- README.md
- mod.rs
- mod.rs
- types.rs
- mod.rs
- mod.rs
- mod.rs
- mod.rs
- config.rs
- error.rs
- main.rs
- transcode.rs
- Cargo.toml
- add_actor_account_event_at.sql
- add_notification_unique_constraint.sql
- backfill_post_embeds.sql
- backfill_post_embeds_batched.sql
- create_sub_state.sql
- dedupe_notifications.sql
- mod.rs
- tests.rs
- car_loader.rs
- cleanup_stale_deactivated.rs
- direct_index.rs
- firehose_catchup.rs
- fix_blob_refs.rs
- label_sync.rs
- plc_import.rs
- queue_backfill.rs
- bulk.rs
- mod.rs
- tests.rs
- backfill_queue.rs
- backfill_queue_tests.rs
- labels.rs
- mod.rs
- tests.rs
- config.rs
- lib.rs
- main.rs
- metrics.rs
- storage.rs
- types.rs
- backfiller_integration.rs
- Cargo.toml
- README.md
- backfill_status.sh
- deploy-wintermute.sh
- priority_backfill_followers.py
- rollback-wintermute.sh
- .dockerignore
- .gitignore
- .gitmodules
- Cargo.lock
- Cargo.toml
- CONTRIBUTING.md
- LICENSE
- README.md
- ROADMAP.md
- rust-toolchain
- TODO.md
# Installation Guide
1. Get the code
git clone https://github.com/blacksky-algorithms/rsky
Downloads the entire project code from GitHub to your computer.
cd rsky
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f rsky-feedgen/Dockerfile -t rsky .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 rsky
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
cd rsky-satnav
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
4. Python
EasyPrerequisites
pip install .
Installs the package published on PyPI directly โ no need to clone the source.
python <์คํํ ํ์ผ๋ช
>.py # README์์ ์ ํํ ์คํ ํ์ผ๋ช
์ ํ์ธํ์ธ์
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
5. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)