-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
content: ported compilation and installation wiki page to website
- Loading branch information
1 parent
da8d93d
commit 2aef963
Showing
2 changed files
with
200 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,186 @@ | ||
--- | ||
title: "" | ||
linkTitle: "Compilation and Installation" | ||
weight: 4 | ||
menu: false | ||
type: docs | ||
--- | ||
|
||
|
||
{{< blocks/lead color="secondary" class="title-box" >}} | ||
## Compile it yourself | ||
{{< /blocks/lead >}} | ||
|
||
{{% blocks/section color="light" class="no-flex contains-code-snippets" %}} | ||
|
||
<span class="spacer"></span> | ||
|
||
- You can compile Rosenpass yourself. This gives you the advantage of ensuring that you use Rosenpass as exactly as the source code is in Git. | ||
|
||
1. Install the dependencies. Under Debian, you can do this with the following command: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
sudo apt-get --yes install libsodium-dev libclang-dev cmake pkg-config git build-essential | ||
``` | ||
|
||
</span> | ||
|
||
2. If you want to use Rosenpass with WireGuard, install WireGuard. On Debian, you can do this with the following command: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
sudo apt-get --yes install wireguard | ||
``` | ||
</span> | ||
|
||
3. Install Rust >= 1.64.0 (as of 2023-07-01). This can be achieved using [Rustup](https://rustup.rs/), for example. | ||
<span class="spacer"></span> | ||
4. Clone the Git Repository: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
git clone https://github.com/rosenpass/rosenpass.git | ||
``` | ||
|
||
</span> | ||
|
||
5. Change to the Rosenpass directory: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
cd rosenpass | ||
``` | ||
|
||
</span> | ||
|
||
6. Switch to the version you want to install. Without switching, you will install and compile the dev version. Find the name of the version that you would like to install on the [releases page](https://github.com/rosenpass/rosenpass/releases), or [find the name of the latest release](https://github.com/rosenpass/rosenpass/releases/latest). Use the following command to switch to version, e.g., 0.2.1: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
git checkout v0.2.1 | ||
``` | ||
|
||
</span> | ||
|
||
7. Compile Rosenpass, this may take a while: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
cargo build --release | ||
``` | ||
|
||
</span> | ||
|
||
8. Install Rosenpass: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
sudo install target/release/rosenpass /usr/local/bin | ||
``` | ||
|
||
</span> | ||
|
||
9. If you want the Rosenpass helper: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
rp | ||
``` | ||
|
||
</span> | ||
|
||
It can be installed it with: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
sudo install rp /usr/local/bin | ||
``` | ||
|
||
</span> | ||
<span class="spacer"></span> | ||
|
||
**That's it! You have now downloaded, compiled, and installed Rosenpass.** | ||
|
||
<span class="spacer"></span> | ||
|
||
{{< /blocks/section >}} | ||
|
||
{{< blocks/lead color="secondary" class="title-box" >}} | ||
## Installation via binary files | ||
{{< /blocks/lead >}} | ||
|
||
{{% blocks/section color="light" class="no-flex contains-code-snippets" %}} | ||
|
||
<span class="spacer"></span> | ||
|
||
- If Rosenpass is not yet available for your distribution, you can attempt to download it manually. | ||
|
||
1. Download the desired version for your operating system from the [releases page](https://github.com/rosenpass/rosenpass/releases/), or directly jump to the [latest version](https://github.com/rosenpass/rosenpass/releases/latest). | ||
<span class="spacer"></span> | ||
2. Unzip the file. On Linux you can use tar for this: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
tar xf rosenpass-x86_64-linux-0.2.1.tar | ||
``` | ||
|
||
</span> | ||
|
||
3. Install Rosenpass: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
sudo install bin/rosenpass /usr/local/bin | ||
``` | ||
|
||
</span> | ||
|
||
4. If you want the Rosenpass helper: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
rp | ||
``` | ||
|
||
</span> | ||
|
||
It can be installed it with: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
sudo install bin/rp /usr/local/bin | ||
``` | ||
|
||
</span> | ||
|
||
5. Delete the downloaded files: | ||
|
||
<span class="codebox"> | ||
|
||
```sh | ||
rm -r rosenpass-x86_64-linux-0.1.1.tar bin/ | ||
``` | ||
|
||
</span> | ||
|
||
<span class="spacer"></span> | ||
|
||
**That's it! You have now downloaded and installed Rosenpass.** | ||
|
||
<span class="spacer"></span> | ||
|
||
{{< /blocks/section >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters