Contents

Docs / How-to guides

Change access, pause or delete a server

Make a server public or private, turn its calls away for a while, or remove it for good.

A server's Overview shows how it's doing at a glance, and below that, under Manage this server, the Access and Delete server cards this page covers.

See how it's doing

The top of the Overview is a set of tiles, each a link to where its numbers come from:

  • Whether the server is answering, with the share of this month's calls it answered and a strip of the last 30 days. A day with failed calls shows amber or red; a day without calls is a short stub.
  • Today's tool calls per hour (UTC), with the hours that had errors marked, against yesterday by the same hour.
  • The month's most-called tools, the newest deploys and previews, and what the checks found in the live deploy, with a way to the Tools tab to fix it.
  • Latency today, errors today with the newest one, the connected clients, and how many of the tools read, write, delete or reach the world.
  • Edit locally, which opens the same dialog as the header's button: the sokie edit command for your editor (Edit locally). And the server's secrets.

Times are UTC. Latency is kept in buckets, so a median of "50 ms" means at most 50 ms.

Make a server public or private

Choose Make public, and confirm. Anyone with the address can then call its tools, with no sign-in. Choose Make private to go back: only clients you approve can call it again.

A switch redeploys the server's live source with the new setting, so it takes effect when that deploy goes live, and the card says so while it runs. If the deploy fails, the server stays as it was, and the card links to the deploy that says why. A server whose API takes each caller's own key or sign-in can't be made public: Sokie needs to know whose key to send. A server with nothing deployed yet just takes the new setting.

While a server is public, clients that signed in to it can't renew their access. Make it private again and they can.

A preview keeps the setting it was built with until its pull request's next push.

Where its deploys come from

The Deploys tab starts with where deploys come from: uploads from sokie deploy, or a linked GitHub repository. Linked, it shows what each recent push and pull request did, and lets you unlink; a broken link or a permission the Sokie App still needs is said there. See Link a repository.

Pause a server

Choose Pause to turn every call away, from the server's address and its previews alike, until you choose Resume. Nothing is lost while it's paused: its deploys, secrets and settings stay as they are. Connected clients stay connected, but can't renew their access until it's resumed.

Delete a server

Choose Delete server, type the server's name to confirm, and choose Delete server again. Its address stops answering at once, and its deploys, previews, secrets, callers' keys and connected clients go with it. This can't be undone. The repository isn't touched, so you can deploy it again as a new server with sokie deploy --create, at a new address.

A server can't be deleted while a deploy is building. Wait for it to finish, then try again.