Opened 6 years ago

Closed 5 years ago

#11144 closed defect (implemented)

Have a better way to manage torrc.sample

Reported by: nickm Owned by:
Priority: Medium Milestone: Tor: 0.2.6.x-final
Component: Core Tor/Tor Version:
Severity: Keywords: tor-relay, 026-triaged-1, nickm-patch
Cc: weasel Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

It's difficult to make changes to torrc.sample, since IIUC it's also used as the basis for the default torrc on Debian (and elsewhere?), so when we make cosmetic changes to it, users everywhere are forced to rebuild their configuration.

Perhaps we should have a torrc that's the one we edit frequently, which we treat as a real sample configuration, and which we give to users who haven't installed tor before or made changes to the default torrc?

Child Tickets

TicketStatusOwnerSummaryComponent
#10343closedspecify units in torrc.sampleCore Tor/Tor
#12832closednickmTypo in torrc.sample.inCore Tor/Tor

Change History (12)

comment:1 Changed 6 years ago by nickm

Weasel, I think we talked about this before at some point; I'd love to know what you think we should do here in order to make some file that would play the role of "here's a sample torrc if you're starting from scratch" that would give us the freedom to make all the cosmetic changes we want.

comment:2 Changed 6 years ago by weasel

I think my preferred solution would be to ship a mostly empty /etc/tor/torrc, and a longer one in /usr/share/doc/tor. The one in /etc/tor could maybe just point to /usr/share/doc.

comment:3 Changed 5 years ago by nickm

Any suggestions for good names for these two torrc files (as shipped with the tor source)?

comment:4 Changed 5 years ago by nickm

Keywords: 026-triaged-1 added

comment:5 Changed 5 years ago by anon

torrc.sample as mostly empty in /etc/tor/ pointing to complete or long version in /usr/share/doc/tor/torrc.sample.complete == my druthers.

comment:6 Changed 5 years ago by nickm

I don't care for the name "complete", since it tends to imply that it would include _every_ option. And giving people a template that lists every possible option is not a great idea; it's smarter to list the options that one might reasonably want to think about.

In fact, it might be a good idea to have multiple /usr/share/doc/tor/torrc* files for different scenarios, like running a relay, running a client, running a bridge, running a hidden service, etc.

comment:7 Changed 5 years ago by nickm

There's a branch for this, using names suggested by weasel, in my public repo. The branch is called "torrc_minimal". It also has the patch for #12832 and a fix for #10343. Weasel, is this about what you had in mind?

comment:8 Changed 5 years ago by nickm

Status: newneeds_review

comment:9 Changed 5 years ago by nickm

Keywords: nickm-patch added

Apply a nickm-patch keyword to tickets in needs_review in 0.2.6 where I wrote the patch, so I know which ones I can('t) review myself.

comment:10 in reply to:  6 Changed 5 years ago by arma

Replying to nickm:

In fact, it might be a good idea to have multiple /usr/share/doc/tor/torrc* files for different scenarios, like running a relay, running a client, running a bridge, running a hidden service, etc.

Wouldn't it be cool if we could use #1922 to accomplish this part?

comment:11 Changed 5 years ago by weasel

lgtm

comment:12 Changed 5 years ago by nickm

Resolution: implemented
Status: needs_reviewclosed

merged!

Note: See TracTickets for help on using tickets.