@deadcanaries/orc NPM

This documentation is aimed primarily at users of ORC Server, designed for volunteers to run on dedicated hardware to strengthen the network. It also exposes a complete web interface for remote access via Tor hidden service, which makes it suitable for access from a mobile device.

Installation

We provide several installation options. ORC server is designed to run on Debian based GNU/Linux systems and accessed remotely via Tor Browser or compatible ORC clients. ORC desktop runs on macOS and Linux systems.

Follow our {@tutorial install} to get up and running! Thanks for helping us protect journalists!

Usage

On first run, ORC will generate a fresh configuration and setup the data directory. The first time running ORC Desktop may take some time to start. Your network identity is being "mined". This is to mitigate spam and other abuse.

ORC is designed to just work "out of the box". There should be no need for manual configuration. However, you may modify the created configuration (/etc/orcd/config or ~/.config/orcd/config) as desired (see the {@tutorial config}) and kill the process. Once you are satisfied with your configuration, run ORC again.

Once started, you can setup your node through the Web UI which is accessible via both a local port and onion address printed to the console when running orc and written to $ORC_CONFIG_DIR/bridge.tor/hidden_service/hostname. You can also use the guide for {@tutorial api} to interact with you node if you are a developer or advanced user!

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.