Opened 15 months ago

Last modified 13 months ago

#26619 assigned enhancement

Include in Tor Relay Guide doc instructions on how to deploy relay in OpenBSD

Reported by: ggus Owned by:
Priority: Medium Milestone:
Component: Community/Relays Version:
Severity: Normal Keywords: openbsd
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

Tor Relay Guide doesn't provide any information about how to setup relay in OpenBSD. Is there any reason for this?

Here's the step by step:

OpenBSD

  1. Add these rules in pf file /etc/pf.conf
pass in log on egress proto tcp from any to any port { 9001 }
pass out log on egress proto tcp from any to any port { 9001 }
  1. Enable the new rules
pfctl -f /etc/pf.conf
  1. Configure the repository
echo https://ftp.openbsd.org/pub/OpenBSD >> /etc/installurl
  1. Install the tor package
pkg_add tor
  1. Put the configuration file /usr/local/etc/tor/torrc in place.
#change the nickname "myNiceRelay" to a name that you like
Nickname myNiceRelay
ORPort 9001
ExitRelay 0
SocksPort 0
# Change the email address bellow and be aware that it will be published
ContactInfo tor-operator@your-emailaddress-domain
Log notice syslog
  1. Start the tor daemon and make sure it starts at boot:
rcctl enable tor
rcctl start tor

More information: https://torbsd.org/2017/02/27/running-openbsd-current-for-tor-relays.html

Child Tickets

Attachments (1)

wiki_TorRelayGuide_OpenBSD.txt (581 bytes) - added by egypcio 14 months ago.
wiki/TorRelayGuide/OpenBSD

Download all attachments as: .zip

Change History (18)

comment:2 Changed 15 months ago by gman999

Steps 1-3 *can* be outside the scope of the relay guide, if they are already done.

TorBSD's documentation was meant to be a bit more comprehensive.

Steps 4-6 are likely adequate for most people's need.

comment:3 Changed 15 months ago by nusenu

@ggus: please add and maintain your OpenBSD steps at
https://trac.torproject.org/projects/tor/wiki/TorRelayGuide/OpenBSD

I'll link it from the main page once it is there.

comment:4 in reply to:  3 ; Changed 15 months ago by ggus

Replying to nusenu:

@ggus: please add and maintain your OpenBSD steps at
https://trac.torproject.org/projects/tor/wiki/TorRelayGuide/OpenBSD

I'll link it from the main page once it is there.

Hi, I moved the additional steps to /TorRelayGuide/OpenBSD page.

Steps 4-6 will be integrated in the main page, right?

comment:5 in reply to:  4 Changed 15 months ago by nusenu

Replying to ggus:

Steps 4-6 will be integrated in the main page, right?

no, please make sure it is self-contained as all the other OS specific sections.

also please ensure to make it writable only to you and other torproject members (as far as I understand you are a tor core person as per https://www.torproject.org/about/corepeople.html.en )

comment:6 Changed 15 months ago by nusenu

Owner: changed from Nusenu to ggus
Status: newassigned

comment:7 Changed 15 months ago by gman999

I'm a bit confused.

Is it the format that is preventing the integration of an OpenBSD section?

comment:8 Changed 15 months ago by nusenu

once you are done I'll link it from
https://trac.torproject.org/projects/tor/wiki/TorRelayGuide#PlatformspecificInstructions
like all other platforms

comment:9 Changed 15 months ago by ggus

It's done.

comment:10 Changed 15 months ago by nusenu

thanks for adding it.

this way users get tor 0.3.2.10, what is their upgrade path when 0.3.2.11 shows up with important security fixes?

comment:11 Changed 14 months ago by nusenu

#27001 closed as a duplicate of this

Changed 14 months ago by egypcio

wiki/TorRelayGuide/OpenBSD

comment:12 Changed 14 months ago by egypcio

moved suggested text (wiki_TorRelayGuide_OpenBSD.txt) from #27001 to this ticket;
setup should work out-of-the-box for any recent/updated OpenBSD system now;
prior to #27001 the documented steps lead to errors and a non-working relay setup.

comment:13 Changed 14 months ago by nusenu

Cc: nusenu removed
Owner: changed from ggus to nusenu

since ggus didn't commment here since 4 weeks I'm reassigning this one again.

There have been a few wiki changes without much reasoning, I'll revert them partially and make a few additional changes:

  • restore the nickname explanation
  • restore OpenBSD's default torrc lines (User, RunAsDaemon)
  • remove the flags, they are unnecessary (/etc/tor/torrc is the default path, User is in torrc)
  • don't consider updates as optional (we don't want people to run stable without package updates)
  • set the page to read-only to encourage reasoning before changes are made and to minimize the "restore efforts"

If you have objections please comment.

comment:14 Changed 14 months ago by egypcio

ggus is that page's author and he allowed me to edit the contents of that page (the same is also applied to the /FreeBSD page; core people allowed me to do the same there and for all the *BSD pages I asked to work with and dedicate my time to).

you took over /FreeBSD, /BSDUpdates, and /OpenBSD and enabled the 'read-only' mode all by yourself without even consulting the original author or anyone else - when I merged contents to the /FreeBSD's, I did not locked people out. I also did not enable read-only mode for the rest of the pages people trusted me to update.

AFAIK, the whole idea of having a collaborative wiki/project is that people can help each other and bring our best to the community, discussing and elaborating good and easy to read/implement steps (plus consistency and standards to work out of the box).

the info regarding User and RunAsDamon were restored sounds strange, because these options never appeared at the wiki page. optional updates? where? from version 7 to version 10 it was written there about two alternatives to bring an updated version of Tor to OpenBSD, not that people could just ignore it.

is there any particular reason why you enabled the read-only mode on /FreeBSD, /BSDUpdates, and /OpenBSD? I think this a pretty odd behavior. I'm sorry. if you do want to own all these pages (and many other more), please tell us. should we always open tickets with suggestions? - sadly it also sounds extra odd, because when I did open tickets (#27006 and #27007), a few minutes later you changed contents all by yourself and after changing the page you opened two tickets (#27025 and #27027, those were gently worked/answered and considered as enhancements, with benefits for the readers and the network).

so, if you need any kind of help or assistance just ping me 'OTR' (or create tickets if you prefer to) and I will be happy to give attention and time to all these pages/topics we need here. thank you for all your concern and dedication behind this work. very appreciated! wish you (all) a nice weekend.

comment:15 in reply to:  14 ; Changed 14 months ago by nusenu

Replying to egypcio:

the info regarding User and RunAsDamon were restored sounds strange, because these options never appeared at the wiki page.

sorry I didn't mean to say that they ever appeared there, but they appear in the torrc file that is shipped by the OpenBSD port maintainer

for the topics that are outside the scope of this (OpenBSD) ticket:
https://lists.torproject.org/pipermail/tor-dev/2018-August/013376.html

comment:16 in reply to:  15 Changed 14 months ago by egypcio

Replying to nusenu:

Replying to egypcio:

the info regarding User and RunAsDamon were restored sounds strange, because these options never appeared at the wiki page.

sorry I didn't mean to say that they ever appeared there, but they appear in the torrc file that is shipped by the OpenBSD port maintainer

for the topics that are outside the scope of this (OpenBSD) ticket:
https://lists.torproject.org/pipermail/tor-dev/2018-August/013376.html

tor-dev@? I really did not expect that. nice. I did read what you wrote there. appreciated C:

would you agree on me adopting /FreeBSD and /BSDUpdates to keep up them in sync and up to date together with /OpenBSD, /NetBSD, /DragonFlyBSD and other *BSD pages? I would love to keep focused on writing such materials (other BSD systems to be added, btw) and you wouldn't be too much overloaded.

ty for your time, concern and constructive discussion&critiques. kr,

comment:17 Changed 13 months ago by nusenu

Owner: nusenu deleted
Note: See TracTickets for help on using tickets.