docs: keep up with changed reality.
ugly hack with relativ URLs because relref is apparently broken when linking to section pages (_index.md) except for a few cases...
This commit is contained in:
+31
-24
@@ -4,39 +4,46 @@ title = "zrepl - ZFS replication"
|
||||
|
||||
# zrepl - ZFS replication
|
||||
|
||||
`zrepl` is a tool for replicating ZFS filesystems.
|
||||
zrepl is a tool for replicating ZFS filesystems.
|
||||
|
||||
{{% panel theme="danger" header="Important" %}}
|
||||
`zrepl` as well as this documentation is still under active
|
||||
development. Some of the features below are not implemented yet. Use & test at your own risk ;)
|
||||
{{% / panel %}}
|
||||
{{% notice info %}}
|
||||
`zrepl` as well as this documentation is still under active development.
|
||||
Use & test at your own risk ;)
|
||||
{{% /notice %}}
|
||||
|
||||
## Getting started
|
||||
|
||||
The [5 minute tutorial setup](/tutorial/) gives you a first impression.
|
||||
|
||||
## Main Features
|
||||
|
||||
* filesystem replication
|
||||
* local & over network (SSH)
|
||||
* push & pull mode
|
||||
* snapshots & bookmarks support
|
||||
* feature-negotiation for
|
||||
* resumable `send & receive`
|
||||
* compressed `send & receive`
|
||||
* raw encrypted `send & receive` (as soon as it is available)
|
||||
* access control checks when pulling datasets
|
||||
* [flexible mappings]({{< ref "configuration/overview.md#mapping-filter-syntax" >}}) for filesystems
|
||||
* automatic snapshot creation
|
||||
* periodic interval
|
||||
* automatic snapshot pruning
|
||||
* [Retention Grid]({{< ref "configuration/snapshots.md#retention-grid" >}})
|
||||
|
||||
* Filesystem Replication
|
||||
* [x] Local & Remote
|
||||
* [x] Pull mode
|
||||
* [ ] Push mode
|
||||
* [x] Access control checks when pulling datasets
|
||||
* [x] [Flexible mapping]({{< ref "configuration/map_filter_syntax.md" >}}) rules
|
||||
* [ ] Bookmarks support
|
||||
* [ ] Feature-negotiation for
|
||||
* Resumable `send & receive`
|
||||
* Compressed `send & receive`
|
||||
* Raw encrypted `send & receive` (as soon as it is available)
|
||||
* Automatic snapshot creation
|
||||
* [x] Ensure fixed time interval between snapshots
|
||||
* Automatic snapshot pruning
|
||||
* [x] <i class="fa fa-arrow-right" aria-hidden="true"></i> [Retention Grid]({{< ref "configuration/prune.md#retention-grid" >}})
|
||||
* Maintainable implementation in Go
|
||||
* [x] Cross platform
|
||||
* [x] Type safe & testable code
|
||||
|
||||
## Contributing
|
||||
|
||||
`zrepl` is usable but nowhere near a stable release right now - we are happy
|
||||
about contributors!
|
||||
zrepl is usable but nowhere near a stable release right now - we are happy about contributors!
|
||||
|
||||
* Explore the codebase
|
||||
* These docs live in the `docs/` subdirectory
|
||||
* Document non-obvious / confusing / plain broken things you encounter when using `zrepl` for the first time
|
||||
* Check the *Issues* and *Projects* sections for things to do ;)
|
||||
* Document any non-obvious / confusing / plain broken behavior you encounter when setting up zrepl for the first time
|
||||
* Check the *Issues* and *Projects* sections for things to do
|
||||
|
||||
{{% panel header="<i class='fa fa-github'></i> Getting your code merged"%}}
|
||||
[The <i class='fa fa-github'></i> GitHub repository](https://github.com/zrepl/zrepl) is where all development happens.
|
||||
|
||||
Reference in New Issue
Block a user