user of tahoe client thinks "storage=true" means that their client can use storage #1311

New Issue

zooko · 2011-01-15T18:18:40Z

zooko commented

2011-01-15 18:18:40 +00:00

My wife (who, by the way, is super smart and knowledgeable) is setting up a tahoe client. From her perspective what she is doing has nothing to do with servers. She may or may not be aware that the same source code and configuration file is used for servers as is used for clients. In any case her only goal was to set up a client so she would have been justified in skipping over any documentation that appeared to be about setting up servers.

So, when she was editing tahoe.cfg, she saw helper=False and storage=False and, since she thought that she was configuring a client, she thought she ought to turn those two settings on, because the only interpretation of those settings was whether this client can use those services.

Possible fix would be to add comments in the default tahoe.cfg file, such as a line next to helper=False saying # Shall this node run a helper service that clients can use?. Also, maybe big visible separators delineating which configuration options are about clients and which are about servers.

A larger fix might be to split the client-related and server-related configuration into two separate files, possibly named ~/.tahoe/client.cfg and ~/.tahoe/server.cfg.

(Tahoe-LAFS grew out of the P2P tradition and we often thought of a single "node" performing both client and server behavior. But in practice nowadays that is a very rare way to use it. Note that I'm not proposing that we make it impossible for a single node to do both! I'm only proposing that the terminology, docs, and configuration files assume that one node is going to perform only one of those roles, the better to match user assumptions and common usage.)

My wife (who, by the way, is super smart and knowledgeable) is setting up a tahoe client. From her perspective what she is doing has nothing to do with servers. She may or may not be aware that the same source code and configuration file is used for servers as is used for clients. In any case her only goal was to set up a client so she would have been justified in skipping over any documentation that appeared to be about setting up servers. So, when she was editing `tahoe.cfg`, she saw `helper=False` and `storage=False` and, since she thought that she was configuring a client, she thought she ought to turn those two settings on, because the only interpretation of those settings was whether this client can use those services. Possible fix would be to add comments in the default `tahoe.cfg` file, such as a line next to `helper=False` saying `# Shall this node run a helper service that clients can use?`. Also, maybe big visible separators delineating which configuration options are about clients and which are about servers. A larger fix might be to split the client-related and server-related configuration into two separate files, possibly named `~/.tahoe/client.cfg` and `~/.tahoe/server.cfg`. (Tahoe-LAFS grew out of the P2P tradition and we often thought of a single "node" performing both client and server behavior. But in practice nowadays that is a very rare way to use it. Note that I'm not proposing that we make it impossible for a single node to do both! I'm only proposing that the terminology, docs, and configuration files assume that one node is going to perform only one of those roles, the better to match user assumptions and common usage.)

zooko added the

labels 2011-01-15 18:18:40 +00:00

zooko added this to the undecided milestone 2011-01-15 18:18:40 +00:00

davidsarah commented

2011-01-15 21:27:21 +00:00

Attachment clarify-tahoe-cfg-sections.darcs.patch (13922 bytes) added

create_node.py: add comments to default tahoe.cfg to clarify the meaning of each section. refs #1311

**Attachment** clarify-tahoe-cfg-sections.darcs.patch (13922 bytes) added create_node.py: add comments to default tahoe.cfg to clarify the meaning of each section. refs #1311

clarify-tahoe-cfg-sections.darcs.patch

14 KiB

tahoe-lafs modified the milestone from undecided to soon

2011-01-15 21:30:43 +00:00

davidsarah commented

2011-01-15 21:35:03 +00:00

Replying to zooko:

A larger fix might be to split the client-related and server-related configuration into two separate files, possibly named ~/.tahoe/client.cfg and ~/.tahoe/server.cfg.

-1, this would cause disruption and multiple places to set the same options (since we would have to support existing tahoe.cfg files in addition to any new ones).

[edited the Description field by mistake in the last comment]sorry,

Replying to [zooko](/tahoe-lafs/trac-2024-07-25/issues/6373): > A larger fix might be to split the client-related and server-related configuration into two separate files, possibly named `~/.tahoe/client.cfg` and `~/.tahoe/server.cfg`. -1, this would cause disruption and multiple places to set the same options (since we would have to support existing `tahoe.cfg` files in addition to any new ones). [edited the Description field by mistake in the last comment]sorry,

davidsarah commented

2011-01-15 21:38:34 +00:00

The comment lines need \n endings; I'll add those to the patch after responding to any suggestions on wording.

The comment lines need `\n` endings; I'll add those to the patch after responding to any suggestions on wording.

zooko commented

2011-01-16 03:43:45 +00:00

+1 on the patch (with newlines). Agreed on not splitting tahoe.cfg.

+1 on the patch (with newlines). Agreed on not splitting `tahoe.cfg`.

david-sarah@jacaranda.org commented

2011-01-17 05:59:01 +00:00

In changeset:d3f24736caa21b55:

create_node.py: add comments to default tahoe.cfg to clarify the meaning of each section. fixes #1311

In changeset:d3f24736caa21b55: ``` create_node.py: add comments to default tahoe.cfg to clarify the meaning of each section. fixes #1311 ```

tahoe-lafs added the

fixed

label 2011-01-17 05:59:01 +00:00

tahoe-lafs closed this issue

2011-01-17 05:59:01 +00:00

davidsarah commented

2011-01-17 22:16:06 +00:00

changeset:8a3cb60bf744e424 fixed some tests.

tahoe-lafs modified the milestone from soon to 1.8.2

2011-01-17 22:17:39 +00:00

david-sarah@jacaranda.org commented

2011-01-20 10:04:59 +00:00

In [4976/ticket1306]:

create_node.py: add comments to default tahoe.cfg to clarify the meaning of each section. fixes #1311

In [4976/ticket1306]: ``` create_node.py: add comments to default tahoe.cfg to clarify the meaning of each section. fixes #1311 ```

Sign in to join this conversation.

No Label

LeastAuthority.com automation

code-frontend-ftp-sftp

code-frontend-magic-folder

somebody else's problem

No Milestone

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Reference: tahoe-lafs/trac-2024-07-25#1311