natty
/
magnetar
1
0
Fork 0
Code Issues 4 Pull Requests 1 Packages Projects Releases Wiki Activity
A social networking server anyone can self-host
111 Commits 4 Branches 0 Tags 16 MiB
Vue 62.9%
Rust 20.9%
TypeScript 15%
SCSS 0.5%
JavaScript 0.4%
Other 0.3%
Go to file
Natty 18d526cf8c
Instance meta cache and initial pack processing for users 		2023-10-27 01:41:48 +02:00
.cargo Sparse Cargo protocol 2023-05-19 02:18:26 +02:00
.dev Updated dev hostname in Caddyfile 2023-10-02 19:05:10 +02:00
.woodpecker Updated README.md and new icons 2023-07-28 05:52:12 +02:00
config Initial API authentication implementation 2023-08-02 03:10:53 +02:00
core Experimental Calckey frontend serving 2023-07-07 21:22:30 +02:00
ext_calckey_model Instance meta cache and initial pack processing for users 2023-10-27 01:41:48 +02:00
ext_nodeinfo Experimental Calckey frontend serving 2023-07-07 21:22:30 +02:00
ext_webfinger Experimental Calckey frontend serving 2023-07-07 21:22:30 +02:00
fe_calckey Version unification 2023-10-02 19:11:35 +02:00
magnetar_common Initial API authentication implementation 2023-08-02 03:10:53 +02:00
magnetar_mmm_parser Instance meta cache and initial pack processing for users 2023-10-27 01:41:48 +02:00
magnetar_sdk Instance meta cache and initial pack processing for users 2023-10-27 01:41:48 +02:00
src Instance meta cache and initial pack processing for users 2023-10-27 01:41:48 +02:00
.dockerignore Experimental Calckey frontend serving 2023-07-07 21:22:30 +02:00
.gitignore NodeInfo serde, basic config support, modularization 2023-02-26 03:31:39 +01:00
Cargo.lock MMM: XML serialization and fixed block code parsing 2023-10-26 00:30:11 +02:00
Cargo.toml MMM: XML serialization and fixed block code parsing 2023-10-26 00:30:11 +02:00
Dockerfile Retargeted to Rust 1.71 2023-09-29 22:26:08 +02:00
LICENSE Added an AGPL LICENSE 2023-02-14 02:01:52 +01:00
README.md Added SQL migrations and bootstrapping 2023-07-29 05:20:00 +02:00

README.md

magnetar

Magnetar logo, an 8-pointed star with two symmetrical cones

A social networking server anyone can self-host

This project is in early development.

Quick start

  1. Create a Postgres database
  2. Create a Redis instance
  3. Configure the required options in config/default.toml
  4. Build Magnetar: cargo build --release --workspace --bins
  5. Build the Magnetar Calckey frontend: cd fe_calckey/frontend && pnpm install && pnpm run build
  6. Run Magnetar: ./target/release/magnetar
  7. Build and run a modified version of Calckey, pointed to the same database and Redis
  8. Start up the Magnetar frontend: ./target/release/magnetar_calckey_fe
  9. Set up a reverse proxy based on .dev/Caddyfile

Read further for additional information.

What's inside

Magnetar builds to two primary binaries:

  • magnetar -- The backend
  • magnetar_calckey_fe -- A web server hosting a self-contained frontend

The fe_calckey/frontend directory contains the Calckey-based web frontend.

Additional dependencies

Magnetar depends on a Postgres database, Redis instance, as well as a modified Calckey backend running in tandem.

Building

Magnetar can be built both as standalone binaries or OCI containers (Podman, Docker, ...).

Native

Building the Magnetar backend requires:

  • latest stable Rust toolchain

Building the included Magnetar/Calckey frontend requires:

  • latest stable Rust toolchain
  • Node.js and npm

Steps

  1. Build both the frontend and the backend binaries: 
    cargo build --release --workspace --bins
  2. Switch to the frontend directory: 
    cd fe_calckey/frontend
  3. Install the frontend dependencies: 
    pnpm install
  4. Build the frontend 
    pnpm run build

Container build

Magnetar can be built to a single monolithic OCI image using the provided Dockerfile, containing the Magnetar binaries.

podman build -t magnetar .
# or
docker build -t magnetar .

Running

Follow the steps from the "building" chapter.

Native setup

Debug builds can be run using cargo run --package magnetar --bin magnetar and run --package magnetar_calckey_fe --bin magnetar_calckey_fe.

Monolithic container image

Choose between the backend and frontend using the --entrypoint /magnetar/magnetar and --entrypoint /magnetar/magnetar_calckey_fe respectively.

Mount the directory in /magnetar/config to pass in configuration from the host machine. Alternatively, see the config/default.toml file and pass in corresponding environment variables.

Connecting all components

In order to connect all components of magnetar, a router/reverse proxy is necessary. See .dev/Caddyfile for a template configuration.