Skip to content

Commit 0efebbd

Browse files
authored
Enhance README with standalone mode details
Updated standalone mode configuration and usage instructions on README.
1 parent bac3414 commit 0efebbd

1 file changed

Lines changed: 74 additions & 23 deletions

File tree

README.md

Lines changed: 74 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,76 @@ Build your own plugins for:
113113

114114
### Deployment Modes
115115

116-
`Embedded Mode (Go Library)`
116+
`Standalone Mode:`
117+
118+
Configure server settings via `config.toml`:
119+
120+
```toml
121+
app_name = "Authula"
122+
base_url = "http://localhost:8080"
123+
base_path = "/api/auth"
124+
125+
[database]
126+
provider = "postgres"
127+
# ...
128+
129+
[logger]
130+
level = "info"
131+
132+
[session]
133+
cookie_name = "authula.session_token"
134+
# ...
135+
136+
# and other core settings you can configure...
137+
138+
# finally, configure powerful plugins...
139+
[plugins]
140+
141+
[plugins.secondary_storage]
142+
enabled = true
143+
provider = "redis"
144+
# ...
145+
146+
[plugins.email]
147+
enabled = true
148+
provider = "smtp"
149+
# ...
150+
151+
[plugins.csrf]
152+
enabled = true
153+
# ...
154+
155+
[plugins.email_password]
156+
enabled = true
157+
# ...
158+
159+
[plugins.session]
160+
enabled = true
161+
# ...
162+
163+
# and much more...
164+
```
165+
166+
Then run Authula standalone via Docker:
167+
168+
```bash
169+
docker run -itd -p 8080:8080 \
170+
-v $(pwd)/config.toml:/home/appuser/config.toml \
171+
-e AUTHULA_BASE_URL=http://localhost:8080 \
172+
-e AUTHULA_SECRET=my-app-secret \
173+
-e AUTHULA_DATABASE_URL=<your_connection_string> \
174+
# other env vars depending on plugins used...
175+
ghcr.io/authula/authula:latest
176+
```
177+
178+
You get:
179+
180+
- Auth microservice
181+
- Driven by file-based config
182+
- Deployable using Docker
183+
- Use it alongside any tech stack over HTTP.
184+
185+
`Embedded Mode (Go Library):`
117186

118187
Embed Authula directly into your Go application:
119188

@@ -148,28 +217,10 @@ http.ListenAndServe(":8080", auth.Handler())
148217

149218
You get:
150219

151-
- zero network overhead
152-
- full type safety
153-
- native integration
154-
- maximum performance
155-
156-
---
157-
158-
`Standalone Mode`
159-
160-
Run Authula as a standalone authentication server via Docker:
161-
162-
```bash
163-
docker run -itd -p 8080:8080 \
164-
-v $(pwd)/config.toml:/home/appuser/config.toml \
165-
-e AUTHULA_BASE_URL=http://localhost:8080 \
166-
-e AUTHULA_SECRET=my-app-secret \
167-
-e AUTHULA_DATABASE_URL=<your_connection_string> \
168-
# other env vars depending on plugins used...
169-
ghcr.io/authula/authula:latest
170-
```
171-
172-
Use it from any language or framework over HTTP.
220+
- Zero network overhead
221+
- Full type safety
222+
- Native integration
223+
- Maximum performance
173224

174225
---
175226

0 commit comments

Comments
 (0)