wmantly
158109de59
* docs: cleanup for public release (fix stale/wrong API docs, LICENSE, versions)
Documentation cleanup ahead of the public release announcement. Fixes a set
of confirmed issues from a prior audit:
- LICENSE: fill in MIT template placeholders (theta42, 2026).
- README.md: fix broken API docs link (api.md -> API.md), correct required
Node.js version (13.x -> 20.x), add the missing app_sso_invite group to
the LDAP groups table, scrub hardcoded dc=theta42,dc=com to the generic
dc=example,dc=com used elsewhere, add a "Recommended: Docker or
install.sh" section pointing to DEPLOYMENT.md/docs before the manual
OpenLDAP walkthrough, and drop an emoji from a warning callout.
- nodejs/api.md: deleted — it was a stale/legacy doc with wrong routes,
wrong request bodies, and endpoints that are dead/commented-out code.
The root API.md is the accurate, current reference; README now links
there directly.
- API.md: add the missing app_sso_invite permission group, fix the
documented invite response to match the real {token, link, mail_sent}
payload, document the previously-undocumented GET/PUT/DELETE
/api/user/invite endpoints, add the real allowed_groups field to the
OAuth client management examples, and document POST /api/oauth/authorize
(the endpoint that actually issues the code after consent).
- nodejs/routes/auth.js + API.md: fix "emaill address" typo in the
password-reset response message (source and docs kept in sync).
- DEPLOYMENT.md: fix the top-level summary to mention Redis, matching
docs/deployment.md and the entrypoint behavior it already documents.
Flagged, not changed: tos.md reads like a personal home-lab acceptable-use
policy (Emby/Gitea/Proxmox/Discord/Signal, first-person "the admin") rather
than generic OSS docs. Left in place pending a manual decision to
genericize, relocate, or remove it.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
* docs: genericize tos.md template, track runtime-editable terms in #39
Removes operator-specific references (Emby, Gitea, Proxmox, Discord,
Signal, first-person "the admin") so the shipped tos.md reads as a
neutral starting template rather than one operator's internal policy.
Actual runtime editability (admin/legal editing terms without a code
change) is tracked in issue #39, not implemented here.
---------
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
84 lines
4.1 KiB
Markdown
84 lines
4.1 KiB
Markdown
# Terms of Service
|
|
|
|
*Last updated: June 2026*
|
|
|
|
> **This is a template.** SSO Manager ships this file as a starting point for
|
|
> operators to adapt to their own deployment, organization name, and
|
|
> jurisdiction. Replace the placeholder text below (or the whole document)
|
|
> with terms reviewed by your own admin/legal before relying on it. See
|
|
> [issue #39](https://github.com/theta42/sso-manager-node/issues/39) for the
|
|
> planned admin UI that will let operators edit this document without a code
|
|
> change.
|
|
|
|
Welcome. By creating an account and using any services on this system, you agree to the following terms. Please read them carefully — they're short and written in plain English.
|
|
|
|
---
|
|
|
|
## 1. Who This Applies To
|
|
|
|
These terms apply to anyone with an account on this system, including but not limited to: SSH access, self-managed containers or VMs, and any other services accessible with your credentials.
|
|
|
|
---
|
|
|
|
## 2. Acceptable Use
|
|
|
|
- **Be respectful.** Treat other users and administrators with respect. Harassment, abuse, or intentionally disrupting other users' work is not tolerated.
|
|
- **Do no harm.** Do not attempt to access, modify, damage, or disrupt any system, service, or data you are not explicitly authorized to use — including systems outside this network.
|
|
- **No malicious activity.** Do not use your account to run port scans, exploits, denial-of-service attacks, spam campaigns, or any other activity intended to harm others.
|
|
- **No resource abuse.** Do not use shared infrastructure for cryptocurrency mining, bulk email, or other activities that consume excessive CPU, memory, disk, or bandwidth without prior approval.
|
|
|
|
---
|
|
|
|
## 3. Legal Compliance
|
|
|
|
- You agree to comply with all applicable laws in your jurisdiction and the jurisdiction where this service is operated.
|
|
- Do not store, transmit, access, or distribute any content that is illegal under applicable law.
|
|
- This includes but is not limited to: pirated software, copyrighted content you do not have rights to, and any material that is illegal in your jurisdiction.
|
|
|
|
---
|
|
|
|
## 4. Credential Security
|
|
|
|
- Do not share your password, SSH keys, or any other credentials with anyone — including administrators (who will never ask for your password).
|
|
- You are responsible for all activity that occurs under your account.
|
|
- If you suspect your account has been compromised, notify an administrator immediately and change your password.
|
|
|
|
---
|
|
|
|
## 5. Self-Managed Resources
|
|
|
|
Users with access to containers or virtual machines agree to additional responsibilities:
|
|
|
|
- You are **fully responsible** for everything you run inside your allocated resources.
|
|
- Keep your systems patched and reasonably secured. A compromised VM on the network is everyone's problem.
|
|
- Do not use your allocation to attack, scan, or probe other systems — on this network or anywhere else.
|
|
- Resource abuse (running workloads that harm shared infrastructure or network performance) may result in immediate suspension of your allocation.
|
|
- Do not expose services to the internet without coordinating with an administrator.
|
|
|
|
---
|
|
|
|
## 6. Privacy
|
|
|
|
- Your personal data (name, email address, phone number) is stored solely to operate this service. It will not be sold, rented, or shared with third parties.
|
|
- **Administrators reserve the right to inspect** activity logs, files, running processes, and system usage on shared infrastructure at any time — for security purposes, incident investigation, or to verify compliance with these terms.
|
|
- **You have no expectation of privacy** on systems, storage, or network traffic hosted on this infrastructure.
|
|
|
|
---
|
|
|
|
## 7. Account Termination
|
|
|
|
- Violation of any of these terms may result in **immediate account suspension or deletion without prior notice**.
|
|
- Administrators reserve sole discretion to terminate access for any reason.
|
|
|
|
---
|
|
|
|
## 8. Changes to This Agreement
|
|
|
|
This agreement may be updated at any time. The current version is always available at `/tos`. Continued use of the services after an update constitutes acceptance of the revised terms.
|
|
|
|
---
|
|
|
|
## Questions?
|
|
|
|
Reach an administrator through the SSO manager or your organization's usual support channel.
|