core
/
trifid
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects 7 Releases Wiki Activity

docs update

This commit is contained in:
core 2023-06-23 21:01:13 -04:00
parent e7828df6ea
commit 170d84526e
Signed by: core
GPG Key ID: FDBF740DADDCEECF
5 changed files with 53 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.lock generated
View File

@ -3315,7 +3315,7 @@ checksum = "222a222a5bfe1bba4a77b45ec488a741b3cb8872e5e499451fd7d0129c9c7c3d"
[[package]]
name = "tfcli"
version = "0.1.0"
version = "0.1.1"
dependencies = [
"clap 4.2.7",
"dirs 5.0.1",

3
docs/tfclient/index.md Normal file
View File

@ -0,0 +1,3 @@
# tfclient - a Rust DNClient alternative
TODO

13
docs/tfclient/untested_os.md Normal file
View File

@ -0,0 +1,13 @@
# Help us out - test tfclient on new platforms
There are [lots](index.md#Where_does_trifid_work?) of operating systems in which `tfclient` *should* work, but due to a lack of devices, it cannot be tested. If you have a system running one of these devices and want to help out the project, please test tfclient for functionality on your device!
<div class="alert alert-warning">
<strong>Notice</strong>: While tfclient is almost always perfectly safe, there are always risks to running untested software on production machines. Be careful out there!
</div>
Any findings, positive or negative, can be posted straight to [trifid-devel](https://lists.e3t.cc/~core/trifid-devel).
Thanks!
[Return home](index.md)

9
docs/tfclient/why_not_this_os.md Normal file
View File

@ -0,0 +1,9 @@
# Why cant tfclient support XXXXX?
There are limits to what operating systems and architectures tfclient can support. As you may know, tfclient is based upon the [Nebula](https://github.com/slackhq/nebula) project, maintained by Slack. tfclient can only support architectures and operating systems that [Nebula itself supports](https://github.com/slackhq/nebula/releases/).
In addition, tfclient, being written in Rust, can only function in environments [where Rust compiles well](https://doc.rust-lang.org/nightly/rustc/platform-support.html). For example, this rules out MIPS - `rustc` currently does not function correctly on that architecture, and thus tfclient cannot, and likely never will support that architecture.
Did Nebula add a new architecture, and we missed it? Rust supports a new architecture in a new release? [Let us know!](https://lists.e3t.cc/~core/trifid-devel) We love adding support for new systems whenever we can.
Did we miss an architecture? If your architecture is supported by BOTH Nebula and Rust, but you still get `This architecture is not supported yet :(` when trying to build tfclient, we might have missed you - [get in touch](https://lists.e3t.cc/~core/trifid-devel) and we will work with you to get your system supported :D

27
index.md
View File

@ -15,15 +15,42 @@ The API implementation is tested with the official dnclient implementation, and
- [tfcli documentation](./docs/tfcli/index.md)
- [tfclient documentation](./docs/tfclient/index.md)
- [trifid-api documentation](./docs/trifid-api/index.md)
- [dnapi-rs documentation](https://docs.rs/dnapi-rs)
- [dnapi-rs on crates.io](https://crates.io/crates/dnapi-rs)
- [trifid-pki documentation](https://docs.rs/trifid-pki)
- [trifid-pki on crates.io](https://crates.io/crates/trifid-pki)
- [trifid git repository](https://git.e3t.cc/~core/trifid)
- [trifid announcements mailing list](https://lists.e3t.cc/~core/trifid-announce)
- [trifid patch mailing list](https://lists.e3t.cc/~core/trifid-devel)
- [trifid discussion mailing list](https://lists.e3t.cc/~core/trifid-discuss)
# Where does trifid work?
| Operating System | trifid-api? |
|-------------------------|-----------------------------------------------------------------------------------------|
| Windows amd64 | [Yes](docs/tfclient/index.md) [(untested - help wanted!)](docs/tfclient/untested_os.md) |
| Windows arm64 | [Yes](docs/tfclient/index.md) [(untested - help wanted!)](docs/tfclient/untested_os.md) |
| Darwin (macOS) | [Yes](docs/tfclient/index.md) [(untested - help wanted!)](docs/tfclient/untested_os.md) |
| FreeBSD amd64 | [Yes](docs/tfclient/index.md) [(untested - help wanted!)](docs/tfclient/untested_os.md) |
| Linux i386 | [Yes](docs/tfclient/index.md) |
| Linux amd64 | [Yes](docs/tfclient/index.md) |
| Linux armv5 | [Yes](docs/tfclient/index.md) |
| Linux armv6 | [Yes](docs/tfclient/index.md) |
| Linux armv7 | [Yes](docs/tfclient/index.md) |
| Linux aarch64 | [Yes](docs/tfclient/index.md) |
| Android | Almost [(help wanted!)](docs/trifid_mobile/help.md) |
| iOS | Almost [(help wanted!)](docs/trifid_mobile/help.md) |
| Other operating systems | No, and [likely never will be](docs/tfclient/why_not_this_os.md) |
# Get in touch
Have a question about trifid? Check out the [discussion mailing list](https://lists.e3t.cc/~core/trifid-discuss)! `trifid-discuss` is a mailing list for end-user discussion and questions related to the trifid project.