char
/
conduit
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: recommend using binaries

next
Timo Kösters 2020-10-20 14:18:20 +02:00
parent 3bdaf6e79e
commit d7e56dbfa0
No known key found for this signature in database
GPG Key ID: 24DA7517711A2BA4
2 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
DEPLOY_FROM_SOURCE.md → DEPLOY.md
View File

@ -7,15 +7,24 @@ Make sure you have `libssl-dev` and `pkg-config` installed and the [rust toolcha
## Install Conduit ## Install Conduit
You have to download the binary that fits your machine. Run `uname -m` to see what you need:
- x84_64: `https://conduit.rs/master/x86_64/conduit-bin`
- armv7: `https://conduit.rs/master/armv7/conduit-bin`
- armv8: `https://conduit.rs/master/armv8/conduit-bin`
- arm: `https://conduit.rs/master/arm/conduit-bin`
```bash ```bash
$ sudo useradd -m conduit $ sudo useradd -m conduit
$ sudo -u conduit cargo install --git "https://git.koesters.xyz/timo/conduit.git" $ sudo -u conduit wget <url> -O /home/conduit/conduit-bin && chmod +x /home/conduit/conduit-bin
``` ```
## Setup systemd service ## Setup systemd service
In this guide, we set up a systemd service for Conduit, so it's easy to start, stop Conduit and set it to autostart when your server reboots. Paste the default systemd service below and configure it to fit your setup (in /etc/systemd/system/conduit.service). In this guide, we set up a systemd service for Conduit, so it's easy to
start/stop Conduit and set it to autostart when your server reboots. Paste the
default systemd service you can find below into
`/etc/systemd/system/conduit.service` and configure it to fit your setup.
```systemd ```systemd
[Unit] [Unit]
@ -38,7 +47,7 @@ User=conduit
Group=conduit Group=conduit
Type=simple Type=simple
Restart=always Restart=always
ExecStart=/home/conduit/.cargo/bin/conduit ExecStart=/home/conduit/conduit-bin
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
@ -92,12 +101,12 @@ $ sudo certbot -d conduit.koesters.xyz
## You're done! ## You're done!
Now you can start Conduit with Now you can start Conduit with:
```bash ```bash
$ sudo systemctl start conduit $ sudo systemctl start conduit
``` ```
and set it to start automatically when your system boots with Set it to start automatically when your system boots with:
```bash ```bash
$ sudo systemctl enable conduit $ sudo systemctl enable conduit
``` ```

9
README.md
View File

@ -17,13 +17,12 @@ example) and register on the `https://conduit.koesters.xyz` homeserver.
#### How can I deploy my own? #### How can I deploy my own?
##### From source ##### Deploy
Clone the repo, build it with `cargo build --release` and call the binary Download or compile a conduit binary and call it from somewhere like a systemd script. [Read
(target/release/conduit) from somewhere like a systemd script. [Read more](DEPLOY.md)
more](DEPLOY_FROM_SOURCE.md)
##### Using Docker ##### Deploy using Docker
Pull and run the docker image with Pull and run the docker image with