Files
docs/guides/getting-started.md
T
ed dad815e6c5 docs(search): describe the search and fetch pipeline
Explain the two stages: SearXNG queries DuckDuckGo and Brave, then Keenable fetches the top result pages. Name the SearXNG instance URL and disclose Keenable's logging, retention, processing location, and training use. Correct the claim that web search has no external dependency.
2026-11-19 14:23:27 -05:00

227 lines
11 KiB
Markdown

# Getting started
Welcome. You're joining a **member-governed** AI cooperative — not signing up
for a service from a vendor. You'll help direct the project while getting
private AI chat and API access in return.
This guide covers the three things most new members want: becoming a member,
using the chat, and getting involved in governance.
The co-op's meetings — including the regular member meetings — are all on the
shared [co-op calendar](https://cloud.inference.coop/apps/calendar/p/Ltb6LAbt7NWHH7Td),
where we share dates and details. Check it for what's coming up.
## 1. Become a member
Membership is a **sliding-scale contribution starting at $5/month** through
Open Collective (pay what fits your circumstances).
1. Go to [opencollective.com/inference-cooperative](https://opencollective.com/inference-cooperative).
2. Choose a contribution amount ($5 minimum) and subscribe.
3. After you contribute, you'll land on a "check your inbox" page.
**Within a few minutes, you'll get a welcome email** with a link to set up your
account. Click it and create your login.
> **One thing that matters:** the email address you use on Open Collective and
> the email address you use to set up your account **must match**. Membership is
> verified by matching those two emails. If they differ, you won't be recognized
> as a member. (Contributed without an Open Collective account? You're recognized
> by the email you entered at checkout.)
**On payment timing:** Open Collective charges your contribution on the
collective's billing day, not the day you joined — so your second charge can
arrive sooner than a month after the first. When that leaves a paid month
shorter than a month, we credit the difference automatically as non-expiring
credits, pro-rated to the days lost. It's automatic: no need to ask, claim it,
or contact anyone.
### Your membership includes
- **Private AI chat** through the co-op's shared gateway.
- **API access** for your own tools and projects (see [API access](api-access.md)).
- **A monthly usage allowance** of $15 of credit, shared between chat and API.
- **Credit packs** — buy extra non-expiring credits when you need more.
- **Guest access** — give a friend $2 of credit and 60 days of the co-op.
See [Guest access](guest-access.md).
- **A voice in governance** — how the project is run and where it goes next.
## 2. Use the chat
The chat lives at **[chat.inference.coop](https://chat.inference.coop)**. Log in
with the account you created in step 1.
- **Choose your model.** You can pick not just *which* model but *where* it
runs: **private** (Tinfoil, runs in encrypted enclaves) or **green**
(GreenPT and Regolo, 100% renewable energy — Regolo adds a written
zero-data-retention policy). See the [model list](models.md) for the full
list.
- **Web search.** Click the **globe** next to the message box to base answers
on current web results. Searches use our self-hosted SearXNG instance and
Keenable, a third-party page-fetch service. See [what happens during a
search](#what-happens-when-you-use-web-search).
- **File uploads** — attach a document with the **paperclip** and ask the
chat about it.
- **Tools** — the **Tools menu** next to the message box lists everything the
chat can do: generate images, search the co-op documentation, and more. If
there's a tool you'd like available, ask in #general.
- **Voice** works in both directions: speak to the chat with the microphone
icon, and have replies read aloud.
- **Temporary chats** — for conversations you don't want kept on our servers
at all. Click the **Temporary Chat** toggle (in the chat header) and the
conversation is never saved: it disappears when you leave the page, and
nothing lands in your history or our database. To make this your default,
open **Settings → Conversations** and turn on **Default Temporary Chat**.
For anything sensitive, we recommend a temporary chat — ideally paired with
a 🔒 enclave model. See [Privacy](../governance/privacy-policy.md#4-what-we-can-see-an-honest-caveat)).
Your usage draws from your monthly allowance; you can see it on the
[Member Dashboard](https://dashboard.inference.coop).
If the chat ever says your balance is out, that's the allowance, not an error —
see "Your allowance" below.
> **Moved from the old chat?** The previous Open WebUI instance remains
> readable at [chat-legacy.inference.coop](https://chat-legacy.inference.coop)
> — your full history is here in the new chat, but files you attached in the
> old one are still accessible only there.
### What happens when you use web search
Web search runs in two stages.
1. Our self-hosted **SearXNG** instance at
[search.inference.coop](https://search.inference.coop) sends your query to
**DuckDuckGo** and **Brave**.
2. LibreChat sends the top result URLs to **Keenable**, a third-party
page-fetch service. Keenable reads each page and extracts its text. The model
receives those passages, and the answer cites the sources.
SearXNG runs on co-op infrastructure. Keenable is an external service. The
[privacy policy](../governance/privacy-policy.md#5-search) describes how
Keenable handles fetched URLs and page content. Web search is optional. Leave
the globe off if you do not want pages fetched.
### Add the chat to your phone
The chat works like an app on your phone — no app store needed. Open
[chat.inference.coop](https://chat.inference.coop) in your phone's browser and
log in, then:
- **iPhone (Safari):** tap the **Share** button (the square with an arrow),
then **Add to Home Screen**.
- **Android (Chrome):** tap the **⋮** menu, then **Add to Home Screen**
(or **Install app**).
You'll get an icon on your home screen that opens the chat full-screen, like
any other app. Your login stays active — just tap and chat.
## 3. Get involved in governance
You don't just use the co-op; you help run it. Decisions about models, pricing,
privacy, and direction happen on our **Loomio forum**:
- **[forum.inference.coop](https://forum.inference.coop)** — where members discuss and decide.
- **[matrix.inference.coop](https://matrix.inference.coop)** — our Matrix chat server. Log in
with your co-op account (Cloudron SSO); your Matrix ID is `@username:inference.coop`.
Every member is invited to the **Inference Cooperative** space automatically — check your
invites on first login.
**Using it from any Matrix client** — the server speaks the standard Matrix protocol,
so you can connect from any client:
- **Element** (web, desktop, iOS, Android): on the sign-in screen, click *Edit* next to
"Homeserver" and enter `https://matrix.inference.coop`, then sign in with your co-op
account. (On [app.element.io](https://app.element.io) or the desktop/mobile apps alike.)
**Note:** the new **Element X** apps (iOS/Android/macOS) are *not* currently supported —
they only work with the newer Matrix Authentication Service, which this server doesn't
run yet. Use the classic Element apps (Element Web / Element Desktop / "Element" on the
app stores) or another client below.
- **FluffyChat, Cinny, SchildiChat** or any other client: look for the "custom homeserver"
/ "other server" option in the client's login screen and enter the same address.
- Your co-op account and your existing Matrix account on another server (e.g.
matrix.org or a personal homeserver) are separate identities. **Pick your
identity (optional):** by default, invitations go to your co-op identity
(`@username:inference.coop`). To use an account you already have instead:
1. Open your [dashboard](https://dashboard.inference.coop) and find the
**Matrix chat** card. It shows the Matrix ID currently registered for
you — your co-op identity, or `pending` if your co-op Matrix account
hasn't been created yet (it is created the first time you log in to
Matrix).
2. Click **Use external account**, enter your existing Matrix ID in the
format `@username:server.org`, and click **Save**.
3. Accept the space invitation that arrives in that account — usually
instantly. If the account can't be reached right away, the invitation
is retried automatically each night.
That's all it takes: invitations (and the space) follow whichever identity
you've chosen. Switching back is one click — **Use
@username:inference.coop** on the same card. One identity is active at a
time, and both work equally well in every co-op room.
**Members-only, readable history.** The space is invite-only and unencrypted
so every member can read the full history (including messages from before
they joined). Invites are restricted to admins — so while any member is
welcome to bring a collaborator or guest, an admin sends the invite rather
than members handing the space to outsiders directly.
- **#general** is the main room — say hello, ask questions, start
conversations. Beyond it, the space holds a handful of topical rooms
(infrastructure, design, an automated co-op updates feed) — explore the
space and join whatever is interesting to you. New rooms appear there as
the co-op grows.
- The updates feed is posted by the co-op's automation account. See
[Working with the agent](../operations/agentic-systems.md) for the agents behind
it, what they do, and how members interact with them.
- See the [Charter](../governance/charter.md) for how governance is structured.
- See [Open questions](../governance/open-questions.md) for the decisions currently on the table.
### Help build it
Everything we run is open source, and members are welcome to contribute code,
documentation, and design. See [Infrastructure](../operations/infrastructure.md) for the map
and the "Contributing" section for how to propose changes through
[git.inference.coop](https://git.inference.coop).
## Your allowance and credits
Membership includes **$15 of usage credit each month** (same for every member,
regardless of what you pay), shared between chat and API. It's a starting
value, not a hard rule:
- The allowance resets each month on your personal billing date (the day your
membership payment recurs) — not on a fixed calendar day.
- The allowance can be adjusted per member — contact info@inference.coop.
### Need more than the allowance?
Members can buy **credit packs** — non-expiring credits that kick in
automatically when your monthly allowance runs out:
- Credits **never expire**. Unused credits carry over month to month.
- They're drawn only after the monthly allowance is exhausted, so your
allowance always gets used first.
- Buy a credit pack on our
[Open Collective page](https://opencollective.com/inference-cooperative/contribute)
(choose the "Credit pack" option). Credits are applied to your account
automatically — usually within minutes.
- Credit packs are for members. If you buy one before joining, we'll hold it
and it will be applied to your account when you join (or refunded if you
prefer — just email info@inference.coop).
You can see both buckets — allowance left this cycle and non-expiring credits —
on the [Member Dashboard](https://dashboard.inference.coop).
## Need help?
- **Questions about the service or your account:** info@inference.coop
- **Governance and decisions:** the [forum](https://forum.inference.coop)
- **Building on the API:** [API access](api-access.md)
- **Leaving:** cancel your subscription on Open Collective; your account is
deactivated and your data preserved for reactivation. You may request full
deletion.