Skip to content

Commit

Permalink
doc: Polish unreleased changelogs
Browse files Browse the repository at this point in the history
  • Loading branch information
rawtaz committed Jul 24, 2024
1 parent e8a9fbc commit 75e71aa
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
11 changes: 5 additions & 6 deletions changelog/unreleased/pull-271
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Enhancement: print actual listen address after start-up
Enhancement: Print actual listen address after start-up

When started with `--listen :0` the server would print `start server on :0`
When started with `--listen :0`, rest-server would print `start server on :0`

Now the message includes the actual address listened on, for example
`start server on 0.0.0.0:37333`.

This is useful when starting a server with an auto-allocated free port number (port 0).
The message now also includes the actual address listened on, for example
`start server on 0.0.0.0:37333`. This is useful when starting a server with
an auto-allocated free port number (port 0).

https://github.com/restic/rest-server/pull/271
7 changes: 5 additions & 2 deletions changelog/unreleased/pull-272
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
Enhancement: Support listening on a unix socket

To let rest-server listen on a unix socket, prefix the socket filename with `unix:` and pass it to the `--listen` option, for example `--listen unix:/tmp/foo`.
It is now possible to make rest-server listen on a unix socket by prefixing
the socket filename with `unix:` and passing it to the `--listen` option,
for example `--listen unix:/tmp/foo`.

This is useful in combination with remote port forwarding to enable remote server to backup locally, e.g.
This is useful in combination with remote port forwarding to enable a remote
server to backup locally, e.g.:

```
rest-server --listen unix:/tmp/foo &
Expand Down
8 changes: 5 additions & 3 deletions changelog/unreleased/pull-273
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
Change: Server is now shutdown cleanly on TERM or INT signals
Change: Shut down cleanly on TERM and INT signals

Server now listens for TERM and INT signals and cleanly closes down the http.Server and listener.
Rest-server now listens for TERM and INT signals and cleanly closes down the
http.Server and listener when receiving either of them.

This is particularly useful when listening on a unix socket, as the server will remove the socket file from it shuts down.
This is particularly useful when listening on a unix socket, as the server
will now remove the socket file when it shuts down.

https://github.com/restic/rest-server/pull/273

0 comments on commit 75e71aa

Please sign in to comment.