rilis 0.1.4

Local deployment tools built with Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

# Rilis

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ak9024/rilis/ci.yml?style=for-the-badge) ![GitHub License](https://img.shields.io/github/license/ak9024/rilis?style=for-the-badge) ![GitHub repo size](https://img.shields.io/github/repo-size/ak9024/rilis?style=for-the-badge)

[![asciicast](https://asciinema.org/a/680727.svg)](https://asciinema.org/a/680727)

## Why?

I created this tool to streamline my workflow, allowing seamless communication with my server and automating the deployment process from my local machine to a virtual server. This tool is tailored to address my specific needs for efficient and automated deployments.

## Key Features

- Effortless VM (Virtual Machine) Deployment
- Simply configure with a file `deploy.toml` or `anything.toml` and use `docker-compose.yaml` locally.


## Installation

```shell
# download from crates
cargo install rilis

# download latest version from git
cargo install --git https://github.com/ak9024/rilis
```

Please see the examples [here](https://github.com/ak9024/examples-rilis)

## Configuration

Create configuration named `deploy.toml`.

```toml
[ssh]
# required IPv4 address can be define here.
address = ""
# optional, by default is "root"
username = ""
# You can choose one using "password" or "private_key"
password = ""
# optional if do you want to connect via private_key
private_key = "/Users/adiatma/.ssh/id_ed25519"
# optional by default port 22, but you can customize by your self.
port = 22

[server]
# scp is optional, if do you want to copy file from local to the server, can be define here.
scp = [ "docker-compose.yaml" ]
# ssh commands if do you want to exec script or anything on the server.
commands = [
  "sudo docker compose -f docker-compose.yaml up -d",
  "sudo docker ps",
]

# optional support tunneling from server to your local
# [[port_forward]]
# remote_addr = "your.ip.public:80"
# local_addr = "127.0.0.1:3000"

# [[port_forward]]
# remote_addr = "your.ip.public:4000"
# local_addr = "127.0.0.1:4000"
```

> You can define multiple configuration for multiple use case for automation, examples to provision VM using `setup.toml`, then for deployment using `deploy.toml`.

## Docker

Prepare your `docker-compose.yaml`

```yaml
version: "3.8"

services:
  home:
    container_name: home
    image: httpd:latest
    ports:
      - "3000:80"
```

Then start `rilis --cfg deploy.toml`

## More

```shell
rilis -h
```

## Star History

<a href="https://star-history.com/#ak9024/rilis&Timeline">
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=ak9024/rilis&type=Timeline&theme=dark" />
   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=ak9024/rilis&type=Timeline" />
   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=ak9024/rilis&type=Timeline" />
 </picture>
</a>

## License

MIT & Apache 2.0