Skip to content

Commit ee8275f

Browse files
authored
Merge pull request #206 from Solomon-mithra/docs-fix-admin-auth-confusion
docs: clarify admin password vs stream key authentication
2 parents 63c9548 + 3c9f96d commit ee8275f

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

content/docs/configuration.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,15 @@ weight: 100
88
toc: true
99
---
1010

11-
Configuration is done through the Owncast administration page located on your server under `/admin`. The login username is `admin` and the password is your stream key, the default being `abc123`.
11+
Configuration is done through the Owncast administration page located on your server under `/admin`.
12+
13+
**Admin Authentication:**
14+
- **Username:** `admin`
15+
- **Password:** your admin password (not your stream key)
16+
17+
The default admin password is `abc123`.
18+
19+
**Note:** Your stream key is only used by your streaming software to publish video; it is not your admin password.
1220

1321
**It's highly encouraged to change both your stream key and your admin passwords immediately after installation by visiting `/admin/config/server/`**
1422

content/quickstart/configure.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,15 @@ type: subpages
1212

1313
While Owncast will work for you out of the box, there are things most people will want to customize after getting it up and running.
1414

15-
Configuration is done through the Owncast administration page located on your server under `/admin`. The login username is `admin` and the password is your stream key, the default being `abc123`.
15+
Configuration is done through the Owncast administration page located on your server under `/admin`.
16+
17+
**Admin Authentication:**
18+
- **Username:** `admin`
19+
- **Password:** your admin password (not your stream key)
20+
21+
The default admin password is `abc123`.
22+
23+
**Note:** Your stream key is only used by your streaming software to publish video; it is not your admin password.
1624

1725
Some common items many people would want to update after installing Owncast are:
1826

data/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ components:
112112
AdminBasicAuth:
113113
type: http
114114
scheme: basic
115-
description: The username for admin basic auth is `admin` and the password is the stream key.
115+
description: The username for admin basic auth is `admin` and the password is your admin password (not your stream key). The default password is `abc123`.
116116

117117
responses:
118118
BasicResponse:

0 commit comments

Comments
 (0)