golem15/summercms
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(surf): print the serve URL and admin status on startup

Browse Source 
- Add surf.Router.AdminPrefix (additive): the admin mount path and true
  when BuildRouter mounted the cabana admin, false otherwise
- serve binds with net.Listen before printing, so a busy port fails
  without a misleading URL, then prints the listen address with a
  browser URL and an admin status line: the admin URL, a warning naming
  summer admin:create when backend_users is empty or missing, or
  admin: off with the steps to add an admin controller
- The administrator count is bounded by a 2 s timeout and never fails boot
- route:list ends with the same admin status line
- surf and cabana READMEs and the console and routing docs describe the output
This commit is contained in:
Jakub Zych
2026-10-08 16:36:21 +02:00
parent 4b5ed7707e
commit da21670870
10 changed files with 294 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/console/setup-and-maintenance.md
View File

@@ -55,8 +55,8 @@ Copy the printed value into `SUMMER_APP__KEY`. When you rotate the key, keep the
| Command | Flags | Purpose |
|---------|-------|---------|
| `serve` | `--addr` (default `:8080`) | Opens the database and uploads bucket, builds the router, starts the in-process job worker and serves HTTP until SIGINT or SIGTERM, then shuts down within 10 seconds. |
| `route:list` | none | Builds the router the way `serve` does, without opening the database or listening, and prints every route with its method, pattern, plugin, middleware and raw flag. |
| `serve` | `--addr` (default `:8080`) | Opens the database and uploads bucket, builds the router, binds the address, starts the in-process job worker and serves HTTP until SIGINT or SIGTERM, then shuts down within 10 seconds. After binding it prints the listen address with a browser URL (an unspecified host shows as 127.0.0.1) and an admin status line: the admin URL, or `admin: off` with the steps to add an admin controller. |
| `route:list` | none | Builds the router the way `serve` does, without opening the database or listening, and prints every route with its method, pattern, plugin, middleware and raw flag, followed by the admin status line. |
```sh
./bin/acme route:list
@@ -83,6 +83,8 @@ Both commands prompt for the password without echoing it. In a script, pipe it o
From the application directory, `summer admin:create --email admin@example.com --superuser` runs the same command on the built binary, prompt included.
When the admin is mounted and the `backend_users` table is empty, `serve` prints a warning at start-up naming `summer admin:create`.
## Queues and the scheduler
| Command | Arguments and flags | Purpose |

2
docs/services/routing.md
View File

@@ -189,6 +189,8 @@ do("POST", "/api/blog/posts/7/comments", true)
./bin/acme route:list
```
The table is followed by a line saying whether the admin is mounted and under which prefix, for example `admin: mounted at /backend`.
`surf.BuildRouter` returns the same information to Go code through `surf.Router.Routes`:
```go src=modules/surf/example_test.go#ExampleBuildRouter