Skip to main content

SFTP & SSH access

SFTP & SSH is where you create the logins you use to transfer files and, where you allow it, open a shell into an environment.

These logins are separate credentials. They are not company members: creating one does not invite anybody to Hosting, and removing a member does not remove a login. One person may have a Hosting account and an environment login; the two are unrelated.

What a login can reach​

Every login reaches the environment's shared application files — all of the environment's application trees, not one application and not one folder — plus a shell where the environment allows it. A login lands in /srv, the root those trees are mounted under.

A login is a trusted maintainer

A login can read and change the application configuration, and that configuration contains the application's own database credentials. Read-only (below) stops writes; it does not hide anything. Do not treat two logins as isolated from each other: they run as the same user and can edit each other's files.

Create a login​

  1. Open Hosting → SFTP & SSH.
  2. Choose Add access user.
  3. Give it a username and a label that says who or what it is for.
  4. Add one or more public keys, a password, or both. A login with neither is refused — it could never sign in.
  5. Save.

The page tells you the scope before you create the login, because the choice is hard to take back: once a login exists it reaches the whole environment.

Keys, passwords, and the environment's protocol​

  • Public keys are the safer choice. Paste the public half of a key pair; the private half never leaves the machine that holds it.
  • Password login is an environment-wide setting, Allow password login. New environments allow it; existing environments keep whatever was chosen for them. A password on a login does nothing while the environment refuses passwords.
  • SFTP only is an environment-wide setting that takes the shell away, leaving file transfer. It restricts the protocol, not the files: an SFTP-only login still sees every application tree.

Changes to these settings, and to a login itself or its password, replace the environment's shared Pod: its applications restart with the access service, and every SFTP, SSH and browser-tool session is signed out. The page says so before you save, and a change that has not yet been applied may leave the previous access working for a short while.

Key changes restart nothing. A key added or removed reaches the running SFTP/SSH service within about a minute, and the websites keep serving. Adding a key leaves open sessions alone; removing one ends every open SFTP/SSH and Terminal session, so the removed key cannot stay signed in.

Read-only logins​

Marking a login read-only lets it read and download files but not modify them. It still reaches every application in the environment, and it can still read each application's configuration — including that application's database credentials, which are enough to change the database. Read-only is a file permission, not a boundary.

Marking a login read-only or read-write restarts the access service, for the same reason any other change does.

Connection details​

Once a login has been delivered, its page shows everything needed to connect: the host, the port, the username, and copy-ready ssh/sftp commands plus an ~/.ssh/config example.

  • Use the username shown on the page, exactly. A connection made with a different username is refused, and a refused attempt can be hard to trace afterwards.
  • The port belongs to the environment. If the page shows no connection details yet, the login has not been delivered; the status explains what it is waiting for, and the previous access may still work until the change is applied.

The environment's Connection view also shows its SSH host key as a SHA256: fingerprint, with the whole key under Show full key. Compare it with the fingerprint your SSH client prints on the first connection, or add the full key to ~/.ssh/known_hosts. If the view says Hosting has not confirmed the host key yet, it appears after the environment's next restart.

The Recent refused logins list shows attempts the environment refused, which is the fastest way to spot a typo in a username or a key that never arrived. The list only covers the current access service's lifetime, so a failed attempt from before a restart will not appear.

Using an SSH key pair​

# On the machine you connect from: create a key pair if you do not have one.
ssh-keygen -t ed25519 -C "you@example.com"

# Copy the public half into the login's key field.
cat ~/.ssh/id_ed25519.pub

Never paste the private key anywhere, including into Hosting.

One login's own page​

Choosing a login opens its own page, with four views: Overview, Connection, Keys and Password.

The Overview shows the Username, the Label you gave the login, whether it is Enabled or Disabled, and whether its file access is Read-only or Read and write. The username cannot be changed: it is the account name on the environment, and changing it would change the connection command you have already saved.

Edit access user changes the label, the enabled state and the file permission.

  • Disabling stops the login when the change is applied, ends every SFTP/SSH and browser tool session, and keeps its keys and password so you can enable it again.
  • Changing the file permission restarts the same sessions, because the operating-system identity behind the login is what enforces it.

Both replace the environment's shared Pod, so its applications restart too. If the page says connection details are not available yet, the environment's access endpoint is not ready; the login is not delivered until it is.

The Connection view is the host, port, username, the copy-ready commands and the ~/.ssh/config example described above. It also says when the environment allows SFTP only, when the login itself is disabled, and when password login is off so that a key is required.

Keys on a login​

The Keys view lists the keys attached to the login: each key's Label, its Type, its Fingerprint and the date it was Added. A fingerprint is what you compare against the key on your own machine; the key itself is never shown back, because a public key is only useful on the machine that holds its private half.

Choose Add key to attach another: give it a Key label and paste the Public key. Paste the public half only — the .pub file. A private key is refused. The key starts working within about a minute, without restarting anything: open sessions and the websites keep running.

Choose Remove key beside a key to detach it. The key stops working within about a minute, and every open SFTP/SSH and Terminal session ends then; until it is applied, an existing session may still connect. The websites keep serving, and the files it was used to change are kept.

The login's password​

The Password view says whether a password is stored. It never shows it: the only honest action is to set a new one.

  • Set a password when there is none, or Reset password when there is. Give the new password and confirm it. It is not shown after saving, and it only works while the environment allows password login.
  • Clear password revokes it. The keys stay in place, so the login can still sign in with a key.

Removing a login​

Choose Remove access user to revoke the login. It ends the environment's SFTP/SSH and browser tool sessions, keeps the files it changed, and reserves the username permanently so it cannot be handed to somebody else. It cannot be undone from that screen.

Your own SSH keys​

Your own keys live in your account rather than in an environment: open Account and security from the account menu, then choose SSH keys. A key added here works in every environment where you have been granted access, so it is worth adding once rather than per environment.

Add a key​

Choose Add a key, give it a Label, paste the Public key and confirm your account password. The password is asked for because the key applies to every environment you were already granted, which is a wider change than a profile edit.

The page then tells you where the key is now working, one line per environment, and whether each one is applying or has failed. A failed environment keeps your earlier keys working until the change is applied there; a Company Admin can retry it from that environment's access screen.

Where your keys work​

The list shows each key's label, its type, its fingerprint and the environments it is used in. A key that is not used anywhere yet says so.

Choose Remove beside a key to take it away. The confirmation names every environment it stops working in. Every open SFTP/SSH session in those environments ends when the change is applied; the websites keep running. The label and fingerprint are kept as history.

Access you have received​

The Received access view is the other side of the same thing: the environments where your own keys can sign in, because somebody granted you access. For each one it names the environment, the login your keys become, and the connection commands. A key works only where you have been granted access, and never for the platform's own service login.

Member access grants​

A company member's own personal SSH keys can be delivered to an environment through a grant. A grant names the person's account and the environment login their keys should reach. Company membership alone grants nothing: access is an explicit act.

Removing a member does not remove environment logins, and revoking a member's grant does not remove the login it fed. Removing the login is what removes the login.

Next​