Files
mm/tools/decomp-permuter/src/net/controller/README.md
T
Anghelo Carvajal b6904aa2cc Convert every submodule into subrepo (#170)
* remove ZAPD submodule

* git subrepo clone https://github.com/zeldaret/ZAPD.git tools/ZAPD

subrepo:
  subdir:   "tools/ZAPD"
  merged:   "ca229f19"
upstream:
  origin:   "https://github.com/zeldaret/ZAPD.git"
  branch:   "master"
  commit:   "ca229f19"
git-subrepo:
  version:  "0.4.3"
  origin:   "???"
  commit:   "???"

* git subrepo clone https://github.com/simonlindholm/decomp-permuter.git tools/decomp-permuter

subrepo:
  subdir:   "tools/decomp-permuter"
  merged:   "1e4b85a7"
upstream:
  origin:   "https://github.com/simonlindholm/decomp-permuter.git"
  branch:   "main"
  commit:   "1e4b85a7"
git-subrepo:
  version:  "0.4.3"
  origin:   "???"
  commit:   "???"

* Remove asm-differ

* git subrepo clone https://github.com/simonlindholm/asm-differ.git tools/asm-differ

subrepo:
  subdir:   "tools/asm-differ"
  merged:   "eaf72269"
upstream:
  origin:   "https://github.com/simonlindholm/asm-differ.git"
  branch:   "master"
  commit:   "eaf72269"
git-subrepo:
  version:  "0.4.3"
  origin:   "???"
  commit:   "???"

* remove asm-processor

* git subrepo clone https://github.com/simonlindholm/asm-processor.git tools/asm-processor

subrepo:
  subdir:   "tools/asm-processor"
  merged:   "85288fcd"
upstream:
  origin:   "https://github.com/simonlindholm/asm-processor.git"
  branch:   "master"
  commit:   "85288fcd"
git-subrepo:
  version:  "0.4.3"
  origin:   "???"
  commit:   "???"

* remove .gitmodules file

* Update REAMDE

* Update warnings
2021-06-07 18:31:56 -04:00

24 lines
1.0 KiB
Markdown

# controller
This directory contains code for the central permuter@home controller server,
written in Rust. All p@h traffic passes through here.
If you just want to run a regular p@h server, you don't need to care about this.
To setup your own copy of the controller server:
- Install Rust and (for the libsodium dependency) GCC.
- Run `cargo build --release`.
- Run `./target/release/pahserver setup --db path/to/database.json` and follow
the instructions there. This will set the `priv_seed` part of `config.toml`, and
set up an initial trusted client. The rest of `config.toml` can be copied from
`config_example.toml`.
- Set up a reverse proxy that forwards HTTPS traffic from an external port or route
to HTTP for a port of your choice, e.g. using Nginx or Traefik.
If applicable, configure your firewall to let the external port through.
- Start the server with:
```
./target/release/pahserver run --listen-on 0.0.0.0:<port> --config config.toml --db path/to/database.json
```
and configure the system to run this at startup.