diff options
author | Dimitri Staessens <dimitri@ouroboros.rocks> | 2019-07-05 22:27:04 +0200 |
---|---|---|
committer | Dimitri Staessens <dimitri@ouroboros.rocks> | 2019-07-05 22:27:04 +0200 |
commit | 95258be27446b3584528c5bc7177aca40ddba2d5 (patch) | |
tree | f918e4415eacaacf6e4c7b0d00337990f9095bc4 /content/download | |
parent | e5d3f80261ebaed768ad718bd6fce0df848586fb (diff) | |
download | website-95258be27446b3584528c5bc7177aca40ddba2d5.tar.gz website-95258be27446b3584528c5bc7177aca40ddba2d5.zip |
content: Reorganize to better suit ananke theme
Diffstat (limited to 'content/download')
-rw-r--r-- | content/download/_index.md | 6 | ||||
-rw-r--r-- | content/download/download.md | 26 | ||||
-rw-r--r-- | content/download/install.md | 52 | ||||
-rw-r--r-- | content/download/requirements.md | 71 |
4 files changed, 155 insertions, 0 deletions
diff --git a/content/download/_index.md b/content/download/_index.md new file mode 100644 index 0000000..f7cd806 --- /dev/null +++ b/content/download/_index.md @@ -0,0 +1,6 @@ +--- +title: Download Ouroboros +date: 2019-06-22 +type: page +draft: false +--- diff --git a/content/download/download.md b/content/download/download.md new file mode 100644 index 0000000..226a921 --- /dev/null +++ b/content/download/download.md @@ -0,0 +1,26 @@ +--- +title: "Download Ouroboros" +date: 2019-06-22 +draft: false +--- + +### Get Ouroboros + +**Packages:** + +For ArchLinux users, the easiest way to try Ouroboros is via the [Arch +User Repository](https://aur.archlinux.org/packages/ouroboros-git/), +which will also install all dependencies. + +**Source:** + +You can clone the [repository](/cgit/ouroboros) over http or https or +git: + +``` +$ git clone http://ouroboros.rocks/git/ouroboros +$ git clone https://ouroboros.rocks/git/ouroboros +$ git clone git://ouroboros.rocks/ouroboros +``` + +Or download a [snapshot](/cgit/ouroboros/). diff --git a/content/download/install.md b/content/download/install.md new file mode 100644 index 0000000..ef8220c --- /dev/null +++ b/content/download/install.md @@ -0,0 +1,52 @@ +--- +title: "Install Ouroboros" +draft: false +--- + +We recommend creating a build directory: + +``` +$ mkdir build && cd build +``` + +Run cmake providing the path to where you cloned the Ouroboros +repository. Assuming you created the build directory inside the +repository directory, do: + +``` +$ cmake .. +``` + +Build and install Ouroboros: + +``` +$ sudo make install +``` + +### Advanced options + +Ouroboros can be configured by providing parameters to the cmake +command: + +``` +$ cmake -D<option>=<value> .. +``` + +Alternatively, after running cmake and before installation, run +[ccmake](https://cmake.org/cmake/help/v3.0/manual/ccmake.1.html) to +configure Ouroboros: + +``` +$ ccmake . +``` + +A list of all options can be found [here](/compopt). + +### Remove Ouroboros + +To uninstall Ouroboros, simply execute the following command from your +build directory: + +``` +$ sudo make uninstall +```
\ No newline at end of file diff --git a/content/download/requirements.md b/content/download/requirements.md new file mode 100644 index 0000000..a8444d7 --- /dev/null +++ b/content/download/requirements.md @@ -0,0 +1,71 @@ +--- +title: "Requirements" +draft: false +--- + +### System requirements + +Ouroboros builds on most POSIX compliant systems. Below you will find +instructions for GNU/Linux, FreeBSD and OS X. On Windows 10, you can +build Ouroboros using the [Linux Subsystem for +Windows](https://docs.microsoft.com/en-us/windows/wsl/install-win10) . + +You need [*git*](https://git-scm.com/) to clone the +repository. To build Ouroboros, you need [*cmake*](https://cmake.org/), +[*google protocol buffers*](https://github.com/protobuf-c/protobuf-c) +installed in addition to a C compiler ([*gcc*](https://gcc.gnu.org/) or +[*clang*](https://clang.llvm.org/)) and +[*make*](https://www.gnu.org/software/make/). + +Optionally, you can also install +[*libgcrypt*](https://gnupg.org/software/libgcrypt/index.html), +[*libssl*](https://www.openssl.org/), +[*fuse*](https://github.com/libfuse), *dnsutils* and +[*swig*](http://swig.org/). + +On GNU/Linux you will need either libgcrypt (≥ 1.7.0) or libssl if your +[*glibc*](https://www.gnu.org/software/libc/) is older than version +2.25. + +On OS X, you will need [homebrew](https://brew.sh/). [Disable System +Integrity +Protection](https://developer.apple.com/library/content/documentation/Security/Conceptual/System_Integrity_Protection_Guide/ConfiguringSystemIntegrityProtection/ConfiguringSystemIntegrityProtection.html) +during the [installation](#install) and [removal](#remove) of +Ouroboros. + +### Install the dependencies + +**Debian/Ubuntu Linux:** + +``` +$ apt-get install git protobuf-c-compiler cmake +$ apt-get install libgcrypt20-dev libssl-dev libfuse-dev dnsutils swig cmake-curses-gui +``` + +On some distributions you need to install the protobuf C library +explicitly: + +``` +$ apt-get install libprotobuf-c-dev +``` + +**Arch Linux:** + +``` +$ pacman -S git protobuf-c cmake +$ pacman -S libgcrypt openssl fuse dnsutils swig +``` + +**FreeBSD 11:** + +``` +$ pkg install git protobuf-c cmake +$ pkg install libgcrypt openssl fusefs-libs bind-tools swig +``` + +**Mac OS X Sierra / High Sierra:** + +``` +$ brew install git protobuf-c cmake +$ brew install libgcrypt openssl swig +```
\ No newline at end of file |