Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Service documentation

This documentation covers all services hosted at TPO.

Every service hosted at TPO should have a documentation page, either in this wiki, or elsewhere (but linked here). Services should ideally follow this template to ensure proper documentation. Corresponding onion services are listed on https://onion.torproject.org/.

Supported services

Those are services managed and supported by TPA directly.

ServicePurposeURLMaintainersDocumentedAuth
backupBackupsN/ATPA75%N/A
blogWeblog sitehttps://blog.torproject.org/TPA gus90%GitLab
btcpayserverBTCpayserverhttps://btcpay.torproject.org/TPA sue90%yes
CDNcontent-distribution networkvariesTPA80%yes
ciContinuous Integration testingN/ATPA90%yes
CRMDonation managementhttps://crm.torproject.orgsymbiotic TPA5%yes
debian archiveDebian package repositoryhttps://deb.torproject.orgTPA weasel20%LDAP
dnsdomain name serviceN/ATPA10%N/A
dockerhub-mirrorDocker Hub pull-through cachehttps://dockerhub-mirror.torproject.orgTPA100%N/A (read-only mirror of upstream service)
documentationdocumentation (this wiki)https://help.torproject.org/TPA10%see GitLab
donatedonation site AKA donate-neodonate.torproject.orgTPA lavamind30%N/A
email@torproject.org emails servicesN/ATPA0%LDAP Puppet
forumTor Project community forumshttps://forum.torproject.netTPA hiro gus duncan50%yes
ganetivirtual machine hostingN/ATPA90%no
gitlabIssues, wikis, source codehttps://gitlab.torproject.org/TPA ahf gaba90%yes
grafanametrics dashboardhttps://grafana.torproject.orgTPA anarcat10%Puppet
ipsecVPNN/ATPA30%Puppet
ircIRC bouncer and networkircbouncer.torproject.orgTPA pastly90%yes (ZNC and @groups on OFTC)
ldaphost and user directoryhttps://db.torproject.orgTPA90%yes
listsMailing listshttps://lists.torproject.orgTPA arma atagar qbi20%yes
loggingcentralized loggingN/ATPA10%no
newsletterTor Newsletterhttps://newsletter.torproject.orgTPA gus?LDAP
onionTor's onion serviceshttps://onion.torproject.org/TPA rhatto0%no
object-storageS3-like object storageN/ATPA100%access keys
openstackvirtual machine hostingN/ATPA30%yes
password-managerpassword managementN/ATPA30%Git
postgresqldatabase serviceN/ATPA80%no
prometheusmetrics collection and monitoringhttps://prometheus.torproject.orgTPA90%no
puppetconfiguration managementpuppet.torproject.orgTPA100%yes
rtEmail support with Request Trackerhttps://rt.torproject.org/TPA gus gaba50%yes
schleuderEncrypted mailing listsTPA30%yes
static-componentstatic site mirroringN/ATPA90%LDAP
static-shimstatic site / GitLab shimN/ATPAno
statusstatus dashboardN/ATPA anarcat100%no
support portalSupport portalhttps://support.torproject.orgTPA gus30%LDAP
surveysurvey applicationhttps://survey.torproject.org/TPA lavamind50%yes
svnDocument storagehttps://svn.torproject.org/unmaintained10%yes
tlsX509 certificate managementN/ATPA50%no
websitemain websitehttps://www.torproject.orgTPA gus?LDAP
wkdOpenPGP certificates distributionN/ATPA10%yes

The Auth column documents whether the service should be audited for access when a user is retired. If set to "LDAP", it means it should be revoked to a LDAP group membership change. In the case of "Puppet", it's because the user might have access through that as well.

It is estimated that, on average, 42% of the documentation above is complete. This does not include undocumented services, below.

Tails services

The services below were inherited by TPA with the Tails merge but their processes and infra have not been merged yet. For more information, see:

ServicePurposeURLMaintainersDocumentedAuth
t/apt-repositoriesRepository of Debian packageshttps://deb.tails.net, https://tagged.snapshots.deb.tails.net, https://time-based.snapshots.deb.tails.netTPA?no
t/backupsSurvive disastersTPA?
t/bittorrentDistribution of Tails imagesTPA?
t/dnsResolve domain namesTPA?
t/git-annexStorage of large filesTPA?yes
t/gitlab-runnersContinuous integrationTPA?
t/gitlabIssue tracker and wikihttps://gitlab.tails.boum.org/TPA?yes
t/gitoliteGit repositories with ACL via SSHssh://git.tails.net:3004TPA?yes
t/icinga2Monitoringhttps://icingaweb2.tails.boum.org/TPA?RBAC
t/jenkinsContinuous integrationhttps://jenkins.tails.boum.org/TPA?RBAC
t/mailMTA and SchleuderTPA?
t/mirror-poolDistribute Tailshttps://download.tails.net/tails/?mirrorstatsTPA?no
t/puppet-serverConfiguration managementTPA?
t/rsyncDistribute Tailsrsync://rsync.tails.net/amnesia-archiveTPA?no
t/vpnSecure connection between serversTPA?
t/weblateTranslation of the documentationhttps://translate.tails.netTPA?yes
t/websiteContact info, blog and documentationhttps://tails.net/TPA?no
t/whisperbackBug reportingTPA?no

Unsupported services

The services below run on infrastructure managed and supported by TPA but are themselves deployed, maintained and supported by their corresponding Service admins.

ServicePurposeURLMaintainersDocumentedAuth
anon_ticketAnonymous ticket lobby for GitLabhttps://anonticket.torproject.org/ahf juga10%no
apps team buildersbuild Tor Browser and relatedN/Amorgan10%LDAP
BBBVideo and audio conference systemhttps://bbb.torproject.netgaba gus-yes (see policy)
bridgedbweb app and email responder to learn bridge addresseshttps://bridges.torproject.org/cohosh meskio20%no
bridgestrapservice to tests bridgeshttps://bridges.torproject.org/statuscohosh meskio20%no
checkWeb app to check if we're using torhttps://check.torproject.orgarlolra90%LDAP
collectorCollects Tor network data and makes it availablecollector{1,2}.torproject.orghiro??
gettoremail responder handing out packageshttps://gettor.torproject.orgcohosh meskio10%no
matrixIRC replacementhttps://matrix.orgmicah anarcat10%yes
metricsNetwork descriptor aggregator and visualizerhttps://metrics.torproject.orghiro??
moatDistributes bridges over domain frontingcohosh?no
nextcloudNextCloudhttps://nc.torproject.net/anarcat gaba30%yes
onionperfTor network performance measurements?hiro acute ahf??
ooniOpen Observatory of Network Interferencehttps://ooni.torproject.orghellais?no
rdsysDistribution system for circumvention proxiesN/Acohosh meskio20%no
snowflakePluggable Transport using WebRTChttps://snowflake.torproject.org/cohosh meskio20%no
styleguideStyle Guidehttps://styleguide.torproject.organtonela1%LDAP
vaultSecrets storagehttps://vault.torproject.org/micah10%yes
weatherRelay health monitoringhttps://weather.torproject.org/sarthikg gk?yes

The Auth column documents whether the service should be audited for access when a user is retired. If set to "LDAP", it means it should be revoked to a LDAP group membership change. In the case of "Puppet", it's because the user might have access through that as well.

Every service listed here must have some documentation, ideally following the documentation template. As a courtesy, TPA allows teams to maintain their documentation in a single page here. If the documentation needs to expand beyond that, it should be moved to its own wiki, but still linked here.

There are more (undocumented) services, listed below. Of the 20 services listed above, 6 have an unknown state because the documentation is external (marked with ?). Of the remaining 14 services, it is estimated that 38% of the documentation is complete.

Undocumented service list

WARNING: this is an import of an old Trac wiki page, and no documentation was found for those services. Ideally, each one of those services should have a documentation page, either here or in their team's wiki.

ServicePurposeURLMaintainersAuth
archivepackage archivehttps://archive.torproject.org/boklmLDAP?
communityCommunity Portalhttps://community.torproject.orgGusno
consensus-healthperiodically checks the Tor network for consensus conflicts and other hiccupshttps://consensus-health.torproject.orgtomno?
distpackageshttps://dist.torproject.orgarmaLDAP?
DocTorDirAuth health checks for the tor-consensus-health@ listhttps://gitweb.torproject.org/doctor.gitGeKono
exoneratorwebsite that tells you whether a given IP address was a Tor relayhttps://exonerator.torproject.org/hiro?
extrastatic web stuff referenced from the blog (create trac ticket for access)https://extra.torproject.orgtpaLDAP?
media?https://media.torproject.orgLDAP
onionlist of onion services run by the Tor projecthttps://onion.torproject.orgweaselno
onionooweb-based protocol to learn about currently running Tor relays and bridgeshiro?
peoplecontent provided by Tor peoplehttps://people.torproject.orgtpaLDAP
researchwebsite with stuff for researchers including tech reportshttps://research.torproject.orgarmaLDAP
rpm archiveRPM package repositoryhttps://rpm.torproject.orgkushalLDAP
stemstem project website and tutorialhttps://stem.torproject.org/atagarLDAP?
tb-manualTor Browser User Manualhttps://tb-manual.torproject.org/gusLDAP?
testnetTest network services?dgoulet?

The Auth column documents whether the service should be audited for access when a user is retired. If set to "LDAP", it means it should be revoked to a LDAP group membership change. In the case of "Puppet", it's because the user might have access through that as well.

Research

Those services have not been implemented yet but are at the research phase.

ServicePurposeURLMaintainers
N/A

Retired

Those services have been retired.

ServicePurposeURLMaintainersFate
AtlasTor relay discoverhttps://atlas.torproject.orgirlReplaced by metrics.tpo
cacheWeb caching/accelerator/CDNN/ATPACached site (blog) migrated to TPO infra
CompassAS/country network diversityhttps://compass.torproject.orgkarsten?
fpcentral.tbbbrowser fingerprint analysihttps://fpcentral.tbb.torproject.orgboklmAbandoned for better alternatives
dangerzoneSanitize untrusted documentsN/ATPAOutsourced
gitoliteSource control systemhttps://git.torproject.orgahf, nickm, SebastianReplaced by GitLab
Globehttps://globe.torproject.orgReplaced by Atlas
Help.tpoTPA docs and support helpdeskhttps://help.torproject.orgtpaReplaced by this GitLab wiki
jenkinscontinuous integration, autobuildinghttps://jenkins.torproject.orgweaselReplaced with GitLab CI
kvmvirtual machine hostingN/AweaselReplaced by Ganeti
nagiosalertinghttps://nagios.torproject.orgTPAReplaced by Prometheus
oniongittest GitLab instancehttps://oniongit.euhiroEventually migrated to GitLab
pipeline?https://pipeline.torproject.org?
ProdromusWeb chat for support teamhttps://support.torproject.orgphoul, lunar, helix?
TracIssues, wikihttps://trac.torproject.orghiroMigrated to GitLab, archived
translationTransfifex bridgemajus.torproject.orgemmapeelReplaced with Weblate
Tails XMPPUser support and development channelTails SysadminsMoved to Matrix and IRC, respectively
XMPPChat/messagingdgouletAbandoned for lack of users

Documentation assessment

  • Internal: 20 services, 42% complete
  • External: 20 services, 14 documented, of which 38% are complete complete, 6 unknown
  • Undocumented: 23 services
  • Total: 20% of the documentation completed as of 2020-09-30