@tinyrack/tinyauth-server 0.0.10 → 0.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/readme.md +65 -0
package/package.json
CHANGED
package/readme.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# tinyauth
|
|
2
|
+
|
|
3
|
+
A lightweight, self-hosted OpenID Connect (OIDC) Provider.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **OIDC/OAuth2 Compliant** - Authorization Code Flow with PKCE support
|
|
8
|
+
- **Multiple Auth Methods** - Password, Passkey/WebAuthn, Social Login (GitHub, Google, Apple, Generic OAuth)
|
|
9
|
+
- **Two-Factor Authentication** - TOTP and Passkey as 2FA
|
|
10
|
+
- **Multi-language** - English, Korean, Japanese
|
|
11
|
+
- **Customizable UI** - Themes, branding, background images, terms of service
|
|
12
|
+
- **Database Support** - PostgreSQL, SQLite
|
|
13
|
+
- **Docker Ready** - Production-ready container with health checks
|
|
14
|
+
|
|
15
|
+
## Quick Start
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
docker run -p 8080:8080 -v ./config.yaml:/opt/config.yaml ghcr.io/tinyrack-net/tinyauth
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Visit `http://localhost:8080/.well-known/openid-configuration` to verify the server is running.
|
|
22
|
+
|
|
23
|
+
## Configuration
|
|
24
|
+
|
|
25
|
+
All configuration is done via `config.yaml`:
|
|
26
|
+
|
|
27
|
+
```yaml
|
|
28
|
+
app:
|
|
29
|
+
host: https://auth.example.com
|
|
30
|
+
port: 8080
|
|
31
|
+
|
|
32
|
+
security:
|
|
33
|
+
session_secret: <your-session-secret>
|
|
34
|
+
hash_secret: <your-hash-secret>
|
|
35
|
+
|
|
36
|
+
database:
|
|
37
|
+
type: sqlite
|
|
38
|
+
path: data.db
|
|
39
|
+
|
|
40
|
+
basic_authentication_methods:
|
|
41
|
+
password:
|
|
42
|
+
enabled: true
|
|
43
|
+
passkey:
|
|
44
|
+
enabled: true
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
See [documentation](https://tinyauth.tinyrack.net) for full configuration options.
|
|
48
|
+
|
|
49
|
+
## Development
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
pnpm install
|
|
53
|
+
pnpm dev
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Examples
|
|
57
|
+
|
|
58
|
+
- `examples/clients/nextjs-ssr` - Next.js OIDC client
|
|
59
|
+
- `examples/clients/react-spa` - React SPA PKCE client
|
|
60
|
+
- `examples/servers/cloudflare-hono-d1` - Cloudflare Worker deployment of `@tinyrack/tinyauth-server` with the bundled TinyAuth frontend
|
|
61
|
+
- `examples/servers/node-hono-sqlite` - Node.js library-mode deployment of `@tinyrack/tinyauth-server` with Hono, SQLite, and the bundled TinyAuth frontend
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
[MIT](LICENSE)
|