docs: no update.sh until v1
Nothing has shipped, so there is nothing to update (the script itself was removed in
a152508). The v1.0 definition of done now requires update.sh written, reviewed and
tested on a real server; the admin guide says there are no releases yet.
Task: M11-T7
This commit is contained in:
1 parent
a1525088dc
commit
a6ba61756c
3 files changed
+8
-22
No files matched your search
@@ -2,24 +2,8 @@
|
||||
|
||||
## Updating SelfPhoneNG
|
||||
|
||||
When nobody is on a call, run:
|
||||
|
||||
```sh
|
||||
./scripts/update.sh
|
||||
```
|
||||
|
||||
It:
|
||||
|
||||
1. pulls the latest code (`git pull --ff-only`);
|
||||
2. pulls newer PostgreSQL and Caddy images;
|
||||
3. rebuilds the api and Asterisk images;
|
||||
4. restarts what changed.
|
||||
|
||||
Database changes apply by themselves when the api starts. **Calls in progress drop** if Asterisk is
|
||||
rebuilt. Make a backup first (**Settings → Backups → Back up now**).
|
||||
|
||||
If `git pull` refuses because you changed files in the folder, put your changes somewhere else.
|
||||
Settings belong in the web app and `.env`, not in the code.
|
||||
SelfPhoneNG has no releases yet. How to update will be documented, with a tested update
|
||||
script, when version 1.0 ships.
|
||||
|
||||
### Asterisk security releases
|
||||
|
||||
@@ -35,7 +19,7 @@ docker compose up -d asterisk
|
||||
docker compose exec asterisk asterisk -rx "core show version"
|
||||
```
|
||||
|
||||
The next `update.sh` goes back to the version the code names.
|
||||
A later rebuild without `--build-arg` goes back to the version the code names.
|
||||
|
||||
## Backups
|
||||
|
||||
|
||||
@@ -92,8 +92,8 @@ aren't filtered. The setting is on Settings → Security, with the provisioning
|
||||
### 3.1 Install / update
|
||||
- `scripts/install.sh` (01 §1.3).
|
||||
- `scripts/update.sh`: `git pull --ff-only`, `docker compose build`, `docker compose up -d`. Migrations run automatically on api start. Print the new version.
|
||||
As built (M11-T7): also `docker compose pull --ignore-buildable` (postgres, caddy) and `build --pull`;
|
||||
adds `--profile caddy` when the bundled Caddy container is running. No CHANGELOG.md yet.
|
||||
Not built yet (owner, 2026-10-20): nothing has shipped, so there is nothing to update. Before v1.0
|
||||
ships it must be written, reviewed and thoroughly tested (see the v1.0 definition of done, 09).
|
||||
- Version: `package.json` version at the root, exposed at `/api/system/status`. Semver. `CHANGELOG.md` kept by hand.
|
||||
- Asterisk security releases: bump `ASTERISK_VERSION` in the Dockerfile and rebuild. The admin guide explains how.
|
||||
|
||||
|
||||
@@ -260,4 +260,6 @@ As built: all four tasks done and tested with simulated phones (`scripts/e2e/m10
|
||||
|
||||
## Definition of done for v1.0
|
||||
All of M0–M11 done (including the open real voip.ms checks under M3), plus: 7 days running on the owner's server handling real calls with
|
||||
no crash/restart of the api or Asterisk, and nightly backups restoring cleanly.
|
||||
no crash/restart of the api or Asterisk, and nightly backups restoring cleanly. Also `scripts/update.sh` (08 §3.1) written,
|
||||
reviewed and thoroughly tested on a real server (updating a running install, with calls, backups and the bundled Caddy), with
|
||||
the admin guide's "Updating" section to match.
|
||||
Reference in new issue
Block a user