The Onion Routed Cloud. ORC is a distributed anonymous cloud storage network owned and operated by all of us. Join the discussion in #orc on our community chat!

Build Status | Test Coverage | Node Package | Docker Hub | License (AGPL-3.0)

Quick Start

Pull the image from Docker Hub.

docker pull orcproject/orc

Create a data directory on the host.

mkdir ~/.config/orc

Run the ORC container and mount the data directory.

docker run -v ~/.config/orc:/root/.config/orc -t orcproject/orc:latest

Modify the created configuration at ~/.config/orc/config as desired (see the Configuration Guide) and restart the container for the changes to take effect. Be sure to expose BridgePort and map it to the host.

docker run \
  --publish 127.0.0.1:4445:4445 \
  --volume ~/.config/orc:/root/.config/orc \
  --tty orcproject/orc:latest

See the docker run documentation for more information. If you prefer to install ORC manually, see the guide for Manual Installation. Once installed, simply run orc with an optional configuration file using the --config <path/to/config> option.

Once the container has started, you can navigate in your browser to http://127.0.0.1:4445 to access your node's dashboard! If you did not disable BridgeAuthenticationEnabled, you will be asked for supply the credentials in your configuration file.

Development

To hack on the ORC project, clone this repository and use Docker Compose:

git clone https://github.com/orcproject/orc && cd orc
docker-compose up

This will volume mount the the appropriate directories for development, and then boots up the ORC container. Note that stable releases are tagged and the master branch may contain unstable or bleeding-edge code.

Happy hacking!

Resources

License

ORC - Distributed Anonymous Cloud
Copyright (C) 2017 Counterpoint Hackerspace, Ltd.

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/.