ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-04-09 03:44:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1432 from LeastAuthority/4169.man-page-for-grid-manager
Some checks failed
CI / coverage (macos-14, 3.12) (push) Has been cancelled
Details
CI / coverage (ubuntu-22.04, 3.12) (push) Has been cancelled
Details
CI / coverage (ubuntu-22.04, pypy-3.9) (push) Has been cancelled
Details
CI / coverage (windows-2022, 3.12) (push) Has been cancelled
Details
CI / integration (false, macos-14, 3.11) (push) Has been cancelled
Details
CI / integration (false, ubuntu-20.04, 3.11) (push) Has been cancelled
Details
CI / integration (false, windows-2022, 3.11) (push) Has been cancelled
Details
CI / integration (true, ubuntu-20.04, 3.12) (push) Has been cancelled
Details
CI / packaging (macos-14, 3.9) (push) Has been cancelled
Details
CI / packaging (ubuntu-22.04, 3.9) (push) Has been cancelled
Details
CI / packaging (windows-2022, 3.9) (push) Has been cancelled
Details
CI / finish-coverage-report (push) Has been cancelled
Details

Browse Source 
4169 Add man page for grid manager.
This commit is contained in:
meejah 2025-03-18 17:29:57 -06:00 committed by GitHub
commit e330d85db1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 76 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
docs/man/man1/grid-manager.1 Normal file
View File

@ -0,0 +1,76 @@
.TH GRID-MANAGER 1 "March 2025" "Tahoe-LAFS" "User Commands"
.
.SH NAME
grid-manager \- A Tahoe Grid Manager for issuing certificates to storage-servers.
.
.SH SYNOPSIS
.B grid-manager
[\fIOPTIONS\fR] \fICOMMAND\fR [\fIARGS\fR]...
.
.SH DESCRIPTION
A Tahoe Grid Manager issues certificates to storage-servers.
.
A Tahoe client with one or more Grid Manager public keys configured will only upload to a Storage Server that presents a valid certificate signed by one of the configured Grid Manager keys.
.
Grid Manager configuration can be in a local directory or given via stdin. It contains long-term secret information (a private signing key) and should be kept safe.
.
.SH OPTIONS
.TP
.BR \f[B]-c,\ --config\ \fIPATH\fR
Configuration directory (or - for stdin). \fIRequired.\fR
.TP
.B \f[B]--help
Show help message and exit.
.
.SH COMMANDS
.TP
.B add
Add a new storage-server by name to a Grid Manager.
.TP
.B create
Make a new Grid Manager.
.TP
.B list
List all storage-servers known to a Grid Manager.
.TP
.B public-identity
Show the public identity key of a Grid Manager.
.TP
.B remove
Remove an existing storage-server by name from a Grid Manager.
.TP
.B sign
Sign a new certificate.
.
.SH AUTHORS
Grid Manager has been written by meejah.
.PP
Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn, and numerous other contributors.
.
.SH REPORTING BUGS
Please see
.UR https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug
.UE
.
.PP
Tahoe-LAFS home page:
.UR https://tahoe-lafs.org/
.UE
.PP
Tahoe-LAFS development mailing list:
.UR https://lists.tahoe-lafs.org/mailman/listinfo/tahoe-dev
.UE
.
.SH COPYRIGHT
Copyright \(co 2006\(en2025 The Tahoe-LAFS Software Foundation.
.
.SH SEE ALSO
.MR tahoe 1
.PP
The Tahoe-LAFS documentation on Grid Managers has more detail than this manual page:
.UR https://tahoe-lafs.readthedocs.io/en/latest/managed-grid.html
.UE
.PP
It includes a step-by-step tutorial on how to set up a managed grid:
.UR https://tahoe-lafs.readthedocs.io/en/latest/managed-grid.html#example-setup-of-a-new-managed-grid
.UE