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!
Simply download a pre-built package for your platform from the releases page!
Note! ORC uses the system Tor package on GNU/Linux, so you must install it yourself using your distribution's package manager.
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 {@tutorial config}) and restart the container for the changes to take
effect. Be sure to expose BridgePort and map it to the host if you want to
use the API.
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
{@tutorial install}. 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 to supply the credentials in your configuration file.
When running the ORC server installation with Docker, you can configure your node to periodically check for updates and automatically download the latest image and restart your node to make sure you are always running the latest stable release. Since you already have Docker installed, pull the image for Watchtower and run it.
docker pull v2tec/watchtower
docker run -d --name watchtower -v /var/run/docker.sock:/var/run/docker.sock v2tec/watchtower
Now, Watchtower will check for the latest stable images for running containers and automatically update them.
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.
Alternatively, you can run directly on your host. Use
npm installandnpm linkto install dependencies. Start the daemon withorcdor the desktop application withorc.
Happy hacking!
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/.