veg/tmux-party
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: README quick start leads with hosting, not groupadd

Browse source 
Since host time auto-selects a shared group, most boxes need no
setup. The dedicated 'party' group moves below as the fallback it is.
This commit is contained in:
veg 2026-09-21 09:35:11 +00:00
parent 552b33d25a
commit fa36c29584
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -28,15 +28,6 @@ On illumos/Solaris the default prefix is `/opt/party` and the install needs root
## Quick start ## Quick start
One-time setup, as root. Create the group and add members:
```sh
groupadd party
usermod -aG party alice
usermod -aG party bob
# alice and bob log out and back in so the new group takes effect
```
Host a party, then invite from inside it: Host a party, then invite from inside it:
```sh ```sh
@ -53,7 +44,16 @@ party join standup # attach (auto-attaches if only one party is running)
party leave # detach and clean up party leave # detach and clean up
``` ```
The `party` group is the partyline: filesystem access to party sockets is shared among members, and `tmux server-access` decides who is actually let into a given session. No shared install directory is needed: each party keeps its own state under its own per-party private directory. Parties you haven't been invited to yet show up in `party list` as `invite-only`; `party join` on one tells you which host to ask (exit status 13). No shared group on this box? `party host` says so and prints the recipe. The fallback is a dedicated `party` group, created once as root:
```sh
groupadd party
usermod -aG party alice
usermod -aG party bob
# alice and bob log out and back in so the new group takes effect
```
The gating group is the partyline: filesystem access to party sockets is shared among members, and `tmux server-access` decides who is actually let into a given session. No shared install directory is needed: each party keeps its own state under its own per-party private directory. Parties you haven't been invited to yet show up in `party list` as `invite-only`; `party join` on one tells you which host to ask (exit status 13).
## How it works ## How it works