Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 3.15 KB

README.md

File metadata and controls

76 lines (58 loc) · 3.15 KB
Raw

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 path/to/orc.data

Run the ORC container and mount the data directory.

docker run -v path/to/orc.data:/root/.config/orc -t orcproject/orc:latest

Modify the created configuration at path/to/orc.data/config as desired (see the {@tutorial config}) and restart the container for the changes to take effect. You might wish to expose the ports defined for ControlPort and BridgePort to the host (and update ControlHostname and BridgeHostname to 0.0.0.0) and map them to the host.

docker run \
  --publish 127.0.0.1:4444:4444 \
  --publish 127.0.0.1:4445:4445 \
  --expose 4444 \
  --expose 4445 \
  --volume path/to/orc.data:/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.

Resources

License

ORC - Distributed Anonymous Cloud
Copyright (C) 2017 Gordon Hall
Copyright (C) 2016 Storj Labs, Inc

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