mirror of
https://gitlab.computer.surgery/matrix/grapevine.git
synced 2025-12-16 15:21:24 +01:00
document supported targets
This is also a good spot to link to the pre-built binaries. And since I did that, I can also remove the bit about not publishing binary builds from the introduction section.
This commit is contained in:
parent
28a4483c6e
commit
1808ad66f4
4 changed files with 45 additions and 6 deletions
|
|
@ -4,6 +4,7 @@
|
||||||
* [Code of conduct](./code-of-conduct.md)
|
* [Code of conduct](./code-of-conduct.md)
|
||||||
* [Changelog](./changelog.md)
|
* [Changelog](./changelog.md)
|
||||||
* [Installing](./installing.md)
|
* [Installing](./installing.md)
|
||||||
|
* [Supported targets](./installing/supported-targets.md)
|
||||||
* [Migrating to/from Conduit](./installing/migrating-conduit.md)
|
* [Migrating to/from Conduit](./installing/migrating-conduit.md)
|
||||||
* [Contributing](./contributing.md)
|
* [Contributing](./contributing.md)
|
||||||
* [Coordinated vulnerability disclosure](./contributing/security.md)
|
* [Coordinated vulnerability disclosure](./contributing/security.md)
|
||||||
|
|
|
||||||
|
|
@ -2,3 +2,6 @@
|
||||||
|
|
||||||
This chapter will explain how to start running a Grapevine instance for the
|
This chapter will explain how to start running a Grapevine instance for the
|
||||||
first time.
|
first time.
|
||||||
|
|
||||||
|
**Note:** Pre-built binaries can be found in the [**Supported
|
||||||
|
targets**](./installing/supported-targets.md) subchapter.
|
||||||
|
|
|
||||||
37
book/installing/supported-targets.md
Normal file
37
book/installing/supported-targets.md
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
# Supported targets
|
||||||
|
|
||||||
|
<!-- Keep this table's rows sorted -->
|
||||||
|
<!-- markdownlint-disable-next-line MD013 MD033 -->
|
||||||
|
| Architecture | Vendor | OS | libc | Linkage | Tier | Availability[^1]<sup>, </sup>[^2] |
|
||||||
|
|-|-|-|-|-|-|-|
|
||||||
|
| aarch64 | unknown | linux | musl | static | 2 | Nix, [Download](https://gitlab.computer.surgery/api/v4/projects/matrix%2Fgrapevine/jobs/artifacts/main/raw/grapevine-static-aarch64-unknown-linux-musl?job=artifacts) |
|
||||||
|
| x86_64 | unknown | linux | glibc | dynamic | 1 | Nix |
|
||||||
|
| x86_64 | unknown | linux | musl | static | 2 | Nix, [Download](https://gitlab.computer.surgery/api/v4/projects/matrix%2Fgrapevine/jobs/artifacts/main/raw/grapevine-static-x86_64-unknown-linux-musl?job=artifacts) |
|
||||||
|
|
||||||
|
[^1]: All download links refer to the latest build of the `main` branch.
|
||||||
|
[^2]: All targets can theoretically also be built from source without Nix.
|
||||||
|
However, this may require spending several hours debugging build systems.
|
||||||
|
|
||||||
|
## Target tiers
|
||||||
|
|
||||||
|
The "Tier" column for each target indicates the level of support that target
|
||||||
|
has. Below is an explanation of what each tier means.
|
||||||
|
|
||||||
|
### Tier 1
|
||||||
|
|
||||||
|
Tier 1 targets are guaranteed to:
|
||||||
|
|
||||||
|
* Build
|
||||||
|
* Pass the test suite
|
||||||
|
|
||||||
|
### Tier 2
|
||||||
|
|
||||||
|
Tier 2 targets are guaranteed to:
|
||||||
|
|
||||||
|
* Build
|
||||||
|
|
||||||
|
## Unsupported targets
|
||||||
|
|
||||||
|
Targets that don't appear in the table at the top of this page are unsupported.
|
||||||
|
At any given time, such targets may or may not build, and may or may not pass
|
||||||
|
the test suite.
|
||||||
|
|
@ -91,12 +91,10 @@ the importance of the reliability of a project like this.
|
||||||
## Can I use it?
|
## Can I use it?
|
||||||
|
|
||||||
Theoretically yes, but it's not in a good state for general users yet. There
|
Theoretically yes, but it's not in a good state for general users yet. There
|
||||||
[isn't very much user-facing docs yet][docs-issue], we
|
[isn't very much user-facing docs yet][docs-issue], we [don't have releases
|
||||||
[don't have releases yet][releases-issue], we don't currently publish any binary
|
yet][releases-issue], and there are several breaking changes to the conduit
|
||||||
builds, and there are several breaking changes to the conduit config that
|
config that haven't been documented in detail yet. If these issues don't scare
|
||||||
haven't been documented in detail yet. If building from source and figuring out
|
you away, go for it!
|
||||||
the config by reading source code/commit messages doesn't scare you away, go
|
|
||||||
for it!
|
|
||||||
|
|
||||||
If you use nixos, [here's an example][nixos-example].
|
If you use nixos, [here's an example][nixos-example].
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue