Skip to content

Commit d42d234

Browse files
simonsansimonsan
committed
zola website
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
1 parent a0fc4b4 commit d42d234

25 files changed

+1555
-0
lines changed

Diff for: ‎.github/renovate.json

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": [
4+
"config:recommended",
5+
":dependencyDashboard",
6+
"helpers:pinGitHubActionDigests"
7+
],
8+
"separateMinorPatch": false,
9+
"prCreation": "status-success",
10+
"prHourlyLimit": 1,
11+
"prConcurrentLimit": 1,
12+
"major": {
13+
"dependencyDashboardApproval": true
14+
},
15+
"labels": [
16+
"A-dependencies"
17+
],
18+
"packageRules": [
19+
{
20+
"matchDatasources": [
21+
"github-actions"
22+
],
23+
"labels": [
24+
"A-ci"
25+
]
26+
}
27+
]
28+
}

Diff for: ‎.github/workflows/deploy.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Deploy to Github Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
if: github.ref == 'refs/heads/main'
12+
steps:
13+
- name: checkout
14+
uses: actions/checkout@v4
15+
16+
- name: Build and deploy
17+
uses: shalzz/zola-deploy-action@v0.17.2
18+
env:
19+
PAGES_BRANCH: gh-pages
20+
TOKEN: ${{ secrets.GITHUB_TOKEN }}

Diff for: ‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
public/
2+
_templates/

Diff for: ‎.gitmodules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule "themes/juice"]
2+
path = themes/juice
3+
url = https://github.com/huhu/juice
4+
branch = master

Diff for: ‎config.toml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# The URL the site will be built for
2+
base_url = "https://rustic.cli.rs"
3+
4+
title = "rustic - fast, encrypted, and deduplicated backups"
5+
6+
# Whether to automatically compile all Sass files in the sass directory
7+
compile_sass = true
8+
9+
# Whether to build a search index to be used later on by a JavaScript library
10+
build_search_index = true
11+
12+
theme = "juice"
13+
14+
[markdown]
15+
# Whether to do syntax highlighting
16+
# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
17+
highlight_code = true
18+
highlight_theme = "inspired-github"
19+
20+
[extra]
21+
juice_logo_name = "rustic"
22+
juice_logo_path = "rustic.svg"
23+
juice_extra_menu = [
24+
# { title = "Github", link = "https://github.com/rustic-rs/" },
25+
]
26+
# Add page titles here to exclude them from the nav section (case sensitive)
27+
juice_exclude_menu = [""]
28+
repository_url = "https://github.com/rustic-rs/rustic-rs.github.io "

Diff for: ‎content/_index.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
+++
2+
title = "rustic"
3+
sort_by = "weight"
4+
+++
5+
6+
# Ecosystem
7+
8+
The *rustic* ecosystem currently consists of the following products:
9+
10+
<div class="flex-row">
11+
<div class="flex-column">
12+
<div class="ecosystem-gallery">
13+
<a href="ecosystem/rustic"><img src="https://raw.githubusercontent.com/rustic-rs/assets/main/logos/readme_header.png" height="150" /></a>
14+
<div class="desc">rustic</div>
15+
<div class="desc-sub">deduplicated, encrypted backups</div>
16+
</div>
17+
<div class="ecosystem-gallery">
18+
<a href="ecosystem/rustic-scheduler"><img src="https://raw.githubusercontent.com/rustic-rs/assets/main/logos/readme_header_scheduler.png" height="150" /></a>
19+
<div class="desc">rustic scheduler</div>
20+
<div class="desc-sub">centrally schedule rustic backups</div>
21+
</div>
22+
<div class="ecosystem-gallery">
23+
<a href="https://rustic.cli.rs/docs" target="_blank"><img src="https://raw.githubusercontent.com/rustic-rs/assets/main/logos/readme_header_docs.png" height="150" /></a>
24+
<div class="desc">User Documentation</div>
25+
</div>
26+
</div>
27+
<div class="flex-column">
28+
<div class="ecosystem-gallery">
29+
<a href="ecosystem/rustic-core"><img src="https://raw.githubusercontent.com/rustic-rs/assets/main/logos/readme_header_core.png" height="150" /></a>
30+
<div class="desc">rustic core</div>
31+
<div class="desc-sub">the library powering rustic</div>
32+
</div>
33+
<div class="ecosystem-gallery">
34+
<a href="ecosystem/rustic-server"><img src="https://raw.githubusercontent.com/rustic-rs/assets/main/logos/readme_header_server.png" height="150" /></a>
35+
<div class="desc">rustic server</div>
36+
<div class="desc-sub">a REST server for rustic and restic</div>
37+
</div>
38+
<div class="ecosystem-gallery">
39+
<a href="https://rustic.cli.rs/dev-docs" target="_blank"><img src="https://raw.githubusercontent.com/rustic-rs/assets/main/logos/readme_header_dev.png" height="150" /></a>
40+
<div class="desc">Developer Documentation</div>
41+
</div>
42+
</div>
43+
</div>
44+
45+
# Contributing
46+
47+
Tried tools from our ecosystem and not satisfied? Don't just walk away! You can help:
48+
49+
- You can report issues or suggest new features on our
50+
[Discord server](https://discord.gg/WRUWENZnzQ) or using
51+
[Github Issues](https://github.com/rustic-rs/rustic/issues/new/choose)!
52+
53+
Do you know how to code or got an idea for an improvement? Don't keep it to
54+
yourself!
55+
56+
- [Contribute fixes](https://github.com/rustic-rs/rustic/contribute) or new
57+
features via a pull requests!
58+
59+
Please make sure, that you read the
60+
[contribution guide](https://rustic.cli.rs/docs/contributing-to-rustic.html).
61+
62+
# Stability
63+
64+
Currently our tools are in beta state and miss regression tests. It is not recommended to use them in production backups, yet.

Diff for: ‎content/contact.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
+++
2+
title = "Contact"
3+
description = "📞 Contact"
4+
weight = 99
5+
+++
6+
7+
You can ask questions in the [Discussions](https://github.com/rustic-rs/rustic/discussions) or have a look at the
8+
[FAQ](https://rustic.cli.rs/docs/FAQ.html).
9+
10+
<div class="flex-row">
11+
<div class="flex-column"></div>
12+
<div class="flex-column">Where?</div>
13+
</div>
14+
<div class="flex-row">
15+
<div class="flex-column">Issue Tracker</div>
16+
<div class="flex-column"><a href="https://github.com/rustic-rs/rustic/issues">GitHub Issues</a></div>
17+
</div>
18+
<div class="flex-row">
19+
<div class="flex-column">Discord</div>
20+
<div class="flex-column"><a href="https://discord.gg/WRUWENZnzQ"><img src="https://dcbadge.vercel.app/api/server/WRUWENZnzQ?style=flat-square" /></a></div>
21+
</div>
22+
<div class="flex-row">
23+
<div class="flex-column">Discussions</div>
24+
<div class="flex-column"><a href="https://github.com/rustic-rs/rustic/discussions">GitHub Discussions</a></div>

Diff for: ‎content/ecosystem/rustic.md

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
+++
2+
title = "rustic"
3+
description = "rustic"
4+
weight = 1
5+
+++
6+
7+
<p align="center">
8+
<img src="https://raw.githubusercontent.com/rustic-rs/assets/main/logos/readme_header.png" height="400" />
9+
</p>
10+
<p align="center"><b>fast, encrypted, and deduplicated backups</b></p>
11+
12+
<p align="center">
13+
<a href="https://crates.io/crates/rustic-rs"><img src="https://img.shields.io/crates/v/rustic-rs.svg" /></a>
14+
<a href="https://docs.rs/rustic-rs/"><img src="https://img.shields.io/docsrs/rustic-rs?style=flat&amp;labelColor=1c1d42&amp;color=4f396a&amp;logo=Rust&amp;logoColor=white" /></a>
15+
<a href="https://raw.githubusercontent.com/rustic-rs/rustic/main/"><img src="https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg" /></a>
16+
<a href="https://crates.io/crates/rustic-rs"><img src="https://img.shields.io/crates/d/rustic-rs.svg" /></a>
17+
<a href="https://github.com/rustic-rs/rustic/actions/workflows/nightly.yml"><img src="https://github.com/rustic-rs/rustic/actions/workflows/nightly.yml/badge.svg" /></a>
18+
<p>
19+
20+
# About
21+
22+
*rustic* is a backup tool that provides fast, encrypted, deduplicated backups.
23+
24+
It reads and writes the [restic][1] repo format described in the
25+
[design document][2] and can be used as a *restic* replacement in most cases.
26+
27+
It is implemented in [Rust](https://www.rust-lang.org/), a performant,
28+
memory-efficient, and reliable cross-platform systems programming language.
29+
30+
Hence *rustic* supports all major operating systems (Linux, MacOs, *BSD), with
31+
Windows support still being experimental.
32+
33+
# Features
34+
35+
- Backup data is **deduplicated** and **encrypted**.
36+
- Backup storage can be local or cloud storages, including cold storages.
37+
- Allows multiple clients to **concurrently** access a backup repository using
38+
lock-free operations.
39+
- Backups by default are append-only on the repository.
40+
- The operations are robustly designed and can be **safely aborted** and
41+
**efficiently resumed**.
42+
- Snapshot organization is possible by hostname, backup paths, label and tags.
43+
Also a rich set of metadata is saved with each snapshot.
44+
- Retention policies and cleaning of old backups can be **highly customized**.
45+
- Follow-up backups only process changed files, but still create a complete
46+
backup snapshot.
47+
- In-place restore only modifies files which are changed.
48+
- Uses config files for easy configuration of all every-day commands, see
49+
[example config files](https://github.com/rustic-rs/rustic/tree/main/config).
50+
51+
# Differences to *restic*
52+
53+
We have collected some improvements of *rustic* over *restic*
54+
[here](https://rustic.cli.rs/docs/comparison-restic.html).
55+
56+
# Installation
57+
58+
## From binaries
59+
60+
### [cargo-binstall](https://crates.io/crates/cargo-binstall)
61+
62+
```bash
63+
cargo binstall rustic-rs
64+
```
65+
66+
### Windows
67+
68+
#### [Scoop](https://scoop.sh/)
69+
70+
```bash
71+
scoop install rustic
72+
```
73+
74+
Or you can check out the
75+
[releases](https://github.com/rustic-rs/rustic/releases).
76+
77+
Nightly binaries are available
78+
[here](https://rustic.cli.rs/docs/nightly_builds.html).
79+
80+
## From source
81+
82+
**Beware**: This installs the latest development version, which might be
83+
unstable.
84+
85+
```bash
86+
cargo install --git https://github.com/rustic-rs/rustic.git rustic-rs
87+
```
88+
89+
### crates.io
90+
91+
```bash
92+
cargo install rustic-rs
93+
```
94+
95+
# Getting started
96+
97+
Please check our
98+
[documentation](https://rustic.cli.rs/docs/getting_started.html) for more
99+
information on how to get started.
100+
101+
# Minimum Rust version policy
102+
103+
This crate's minimum supported `rustc` version is `1.70.0`.
104+
105+
The current policy is that the minimum Rust version required to use this crate
106+
can be increased in minor version updates. For example, if `crate 1.0` requires
107+
Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust
108+
1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum
109+
version of Rust.
110+
111+
In general, this crate will be conservative with respect to the minimum
112+
supported version of Rust.
113+
114+
# License
115+
116+
Licensed under either of:
117+
118+
- [Apache License, Version 2.0](https://raw.githubusercontent.com/rustic-rs/rustic/main/LICENSE-APACHE)
119+
- [MIT license](https://raw.githubusercontent.com/rustic-rs/rustic/main/LICENSE-MIT)
120+
121+
at your option.
122+
123+
[1]: https://github.com/restic/restic
124+
[2]: https://github.com/restic/restic/blob/master/doc/design.rst

0 commit comments

Comments
 (0)