ContactInfo information sharing scheme
It’s 100% Open Source and licensed under the BSD 2-clause License.
Requirements
| Name | Version |
|---|---|
| terraform | >= 1.3.0 |
Providers
No providers.
Modules
No modules.
Resources
No resources.
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| abuse | Email address of the abuse handling contact for this Tor relay. This is primariy relevant for Tor exit relays but can also be used on non-exit relays. The @ sign will be automatically substituted with []. | any | null | no |
| aesni | AES-NI is available. | bool | null | no |
| autoupdate | Automatic unattended updates are enabled. | bool | null | no |
| btc | Bitcoin or OpenAlias address where people can send donations to support the operation of this Tor relay. | any | null | no |
| confmgmt | States what configuration managment system is used. Set to “manual” for no configuration management. | string | "terraform" | no |
| cost | Monthly hosting costs the hosting company is charging for the server. Refer to the specification for normalisation rules. | any | null | no |
| cpu | Only relevant for relays running on bare metal. String without spaces describing the used CPU model. | any | null | no |
| dnslocalrootzone | Refer to specification. | bool | null | no |
| dnslocation | Exits only. Refer to specification. | string | null | no |
| dnsqname | Exits only. Refer to specification. | bool | null | no |
| dnssec | Refer to specification. | bool | null | no |
| donationurl | url pointing to a website that contains donation information to support this Tor relay. This MUST be an HTTPS URL. | any | null | no |
| This field contains the email address of the technical contact managing this Tor relay. The @ sign will be automatically substituted with []. | any | null | no | |
| freetext | Free text to be added at the start of the contact info string, typically containing a name of the operator or operator organisation. | string | "" | no |
| hoster | Commercial hoster domain where this server has been ordered. This is supposed to help other relay operators and future relay operators to find hosting providers. Refer to the specification for normalisation rules. | any | null | no |
| keybase | The technical contact’s keybase username. This identifier MUST be usable to create a valid keybase.io profile url. | any | null | no |
| mastodon | url pointing to the entity’s mastodon profile (responsible organization/person). | any | null | no |
| matrix | Matrix user identifier for the technical contact for this Tor relay. | any | null | no |
| memory | Non-persistent memory (RAM) available on this server - measured in MB (Mebibytes). This is the output of free -m on most Unix-based systems. | any | null | no |
| offlinemasterkey | Offline master key is enabled. | bool | null | no |
| os | String stating which OS distribution and version is used. Distribution and version is separated with a “/” sign. | any | null | no |
| otr3 | OTR version 3 key fingerprint without spaces. This key fingerprint relates to the xmpp address given in the xmpp field. | any | null | no |
| pgp | 40 characters PGP key fingerprint (long form) without leading 0x and without spaces. This key relates to the email address given in the email field, but providing the pgp field without an email field is also possible. | string | null | no |
| proof | The proof field is only relevant when the url field is set. It is ignored when url is not set. The proof field gives the operator the option to authenticate the url field. Refer to the specification for more information. | any | null | no |
| sandbox | Sandbox is enabled. | bool | null | no |
| signingkeylifetime | Integer stating the signing key renewal interval in days. | number | null | no |
| tls | Which tls library is used. | any | null | no |
| trafficacct | States if this is an unmetered or metered offering. In case of metered bandwidth the monthly included outbound (TX) traffic in GiB (GibiByte) MUST be provided. If no traffic is included in the monthly costs, this value MUST be set to 0. If the hoster meters in+outbound the hoster provided value must be divided by two. This is an integer value. | any | null | no |
| The entity’s twitter username without the leading @ (non-technical contact). The user MUST be usable to create a valid twitter profile url. If the responsible organization or person has no twitter account, the technical contact’s twitter handle can be used instead. | any | null | no | |
| uplinkbw | Logical network interface speed in Mbit/s (1Mbit/s = 1 000 000 Bit/s) or the value of RelayBandwidthRate in your torrc setting (whatever is smaller). For asymetrical uplinks specify the lower of up- and download bandwidth. | any | null | no |
| url | This field contains an url or hostname pointing to the website of the organization or person responsible for this Tor relay. | any | null | no |
| virtualization | States the underlying virtualization technology used on which the OS is running. Use “baremetal” for bare-metal servers (not virtualized). | any | null | no |
| xmpp | XMPP handle for the technical contact of this Tor relay. The @ sign will be automatically substituted with []. | any | null | no |
| xmr | Monero or OpenAlias address where people can send donations to support the operation of this Tor relay. | any | null | no |
| zec | Zcash address where people can send donations to support the operation of this Tor relay. | any | null | no |
Outputs
| Name | Description |
|---|---|
| rendered | n/a |
Makefile Targets
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Help
Got a question? We got answers.
File a GitLab issue, send us an email or join our Matrix Community.
Matrix Community
Join our Open Source Community on Matrix. It’s FREE for everyone! This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build on our open source code.
Contributing
Bug Reports & Feature Requests
Please use the issue tracker to report any bugs or file feature requests.
Developing
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical “fork-and-pull” Git workflow.
- Fork the repo on GitLab
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from “upstream” before making a pull request!
Copyright
Copyright © 2021-2022 SR2 Communications Limited
License
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Trademarks
All other trademarks referenced herein are the property of their respective owners.
About
This project is maintained by SR2 Communications Limited.
We’re a DevOps Professional Services company based in Aberdeen, Scotland. We ❤️ open source software and specialise in digital human rights and humanitarian projects.
We offer paid support on all of our projects.
Check out our other projects, or hire us to get support with using our projects.
Contributors
 irl |  Owen |
|---|