Skip to main content

How to close an HTTPS link with a login and password or a key

Since app version 1.3.0

Open the tunnel with an HTTPS link, its "Security" tab, the "Sign-in" section, turn on "Login and password", set a login and password and click "Save". Instead of your app, the visitor gets a "Sign in" page and goes no further without the login and password.

This works for tunnels with the HTTPS protocol and a link of their own: when creating the tunnel, it's the option "A website or API at a link of its own".

A login and password for people​

  1. Under "Tunnels", open the tunnel and go to the "Security" tab.
  2. In the "Tunnel protection" card, pick the "Sign-in" section.
  3. Turn on "Login and password".
  4. Fill in "Login" and "Password" (at least 8 characters).
  5. Click "Save".
  6. Open the link in a private window: the "Sign in" page opens instead of your app.

How many logins and keys a link can have depends on the plan: plan comparison.

A key for programs​

Bots and scripts are better off with a key. In the "Sign-in" section, the "Keys for programs" block, click "Create a key", give the key a name and copy it with "Copy the key". A program sends the key in the X-Proxima-Auth header. While the link has a key, it opens only with a key or a login.

The key can also go in a ?proxima_auth= parameter of the link, but then it ends up in server logs and browser history, so the header is safer.

When you change a key, you can keep the old one working for an hour, a day or a week, so you have time to move the new key into your programs. A lost key can be shown again on the computer where it was created, or changed: the app shows the new key at once.

Open paths​

The "Path rules" section can open single paths without signing in, for example /health or /webhooks/*:

  1. Click "Add a rule".
  2. Enter the path and choose what to do: "No sign-in", "Addresses only" or "Login".
  3. Click "Save".

The first matching rule decides; a path with no rule needs a login or a key. A webhook path is best opened only to the sender's addresses: "Addresses only".