Skip to content

README.md

Latest commit

 

History

History
103 lines (78 loc) · 4.02 KB

README.md

File metadata and controls

103 lines (78 loc) · 4.02 KB
Raw

Polycentric Server

Prerequisites

  • Rust (edition 2024)
  • Docker (for PostgreSQL and RustFS (Object storage))

Getting Started

1. Start PostgreSQL

# In the root of the repo.
docker compose up -d postgres kafka

This starts PostgreSQL on port 5432 with user postgres and password testing.

2. Run Migrations

cd migration
DATABASE_URL=postgres://postgres:testing@localhost:5432 cargo run -- fresh

3. Setup .env file

cp .env.example .env

4. Start the Server

cargo run -p server

The server listens on 0.0.0.0:3000, multiplexing gRPC (h2c), gRPC-Web, and plain HTTP routes on the same port.

Environment Variables

All service variables are read and validated once at startup by src/config.rs. A .env file in the working directory is loaded first.

Variable Default Description
DATABASE_URL postgres://postgres:testing@localhost:5432 Postgres connection URL.
POLYCENTRIC_SERVER_NAME http://localhost:3000 Canonical URL of this server. Stamped as the source on produced Kafka events.
POLYCENTRIC_ALLOW_HOSTS POLYCENTRIC_SERVER_NAME Hosts clients may address this server as, comma-delimited — the audiences accepted on auth tokens.
CDN_URL http://localhost:3000 Public URL clients use to fetch blob bodies. Reported by ServerService.GetInfo.
POLYCENTRIC_SCRAPER_URL http://localhost:8855 Base URL of the internal scraper service (link-preview metadata and image proxy).
POLYCENTRIC_MODERATION_IDENTITY (unset) Hex identity string of the trusted moderation service. Unset means no content labels are served.

The shared services/common crates read their own variables:

Variable Default Description
POLYCENTRIC_KAFKA_BROKERS localhost:9092 Kafka bootstrap servers.
POLYCENTRIC_KAFKA_CLUSTER_ID (unset) Prefix applied to topics and consumer group ids ({id}.{name}), so clusters can share a broker.
POLYCENTRIC_KAFKA_SECURITY_PROTOCOL PLAINTEXT Kafka security.protocol.
POLYCENTRIC_KAFKA_SASL_MECHANISM (unset) Kafka SASL mechanism, e.g. SCRAM-SHA-256.
POLYCENTRIC_KAFKA_SASL_USERNAME (unset) Kafka SASL username.
POLYCENTRIC_KAFKA_SASL_PASSWORD (unset) Kafka SASL password.
POLYCENTRIC_KAFKA_SSL_CA (unset) Kafka CA certificate, inline PEM.
POLYCENTRIC_KAFKA_SSL_CERTIFICATE (unset) Kafka client certificate, inline PEM.
POLYCENTRIC_KAFKA_SSL_KEY (unset) Kafka client key, inline PEM.
POLYCENTRIC_KAFKA_BROKER_ADDRESS_FAMILY any Kafka broker.address.family.
POLYCENTRIC_KAFKA_AUTO_OFFSET_RESET latest Consumer auto.offset.reset (used by the workers).
CONTENT_BLOB_OS_BUCKET (required) S3 bucket holding uploaded blob bodies.
CONTENT_BLOB_OS_REGION us-east-1 Bucket region.
CONTENT_BLOB_OS_ENDPOINT (unset) Custom endpoint for S3-compatible stores; leave unset for AWS S3.
CONTENT_BLOB_OS_FORCE_PATH_STYLE false Set true for path-style addressing (required by RustFS).
CONTENT_BLOB_OS_ACCESS_KEY (unset) Static credentials; unset uses the AWS SDK default chain.
CONTENT_BLOB_OS_SECRET_KEY (unset) See above.
RUST_LOG info Log filter.
LOG_FORMAT (auto) json or text; defaults to text on a terminal, JSON otherwise.
METRICS_PORT 9464 Port serving Prometheus GET /metrics.

Running Integration Tests

The integration tests run against a live server, so the server must be running first.

NOTE: not currently maintained.

# In one terminal, start the server
cargo run -p server

# In another terminal, run the tests
cargo test -p integration-tests

Project Structure

protos/polycentric/v2/ - Protobuf definitions
services/server/
  src/            - Server source code
  entity/         - SeaORM entity models (shared by server and migration)
  migration/      - Database migrations
  tests/          - Integration tests (gRPC client tests)