Getting Started with RunFTP
Server Configuration
After deciding on a hosting plan and checking out, you'll be directed to the Server Configuration page.
Here is where you'll choose your URL. By default, the domain will be "runftp.com" but you can choose from a few others that we host as well. Next you will enter your desired subdomain. This should be your company name, or a name by which you or your customers will recognize. In this example, I will be "Acme, Corp" so I will enter "acme" into the subdomain box. The system then confirms whether that subdomain is available.
If so, you may continue to the Encryption Passphrase. This is the base key used to encrypt all files while at rest (uploaded files sitting on our server). This is an extra step of protection to ensure your files are always protected. The passphrase should be a minimum of 16 character. You can enter your own, or use the "Generate" button to generate a 64-character random string.
If everything looks correct, the "Save Configuration" button will become illuminated. When ready, click the button and your choices will be saved, and your account will be provisioned within a matter of seconds.
When complete, the page will change to an information display with your server parameters. You will also find some information here about using your own domain, or you can check out this article for more information.
Creating SFTP Users
The next step to getting everything set up is to add some users. Exactly which users you set up and how you configure them will greatly depend on your use case. If you have any questions, feel free to reach out to our support - we'd love to help!
Generally speaking, you'll want to at least create an admin user -- a user which will have full permissions to all files and subfolders.
Choose a username and secure password and click Add. The username will immediately show up in the listing. From here you can click the Manage menu next to the user, and find addition settings for the user.
User Settings
Here you'll be able to add notes about this specific user, add their email address, or change their password. You can also set the user's Home Directory within your folder structure. You'll first need to create any folders you'd like through an SFTP client, after which they'll show up in this drop-down.
You can also set an IP Address Whitelist filter, to only allow the user to connect from a specific address or address range. If you'd prefer to use SSH keys instead of passwords (a good choice!) you can paste the user's public key here. You can read a full article on that topic here: Creating a private/public key pair using PuTTYgen.
Permissions
Here you'll be able to configure which actions a user can perform. By default the user will have FULL CONTROL. These permissions apply to the user's Home Directory. If you've changed the user's home directory to something other that root (/), then when this user logs in, their root will be the /subfolder. They will not be able to see any files or folders above their home directory. All permissions will apply to the user's home directory level and all files/folders beneath it. The FULL CONTROL overrides all other settings.
A few common scenarios/roles:
Admin User
A user who has full permission to all files/folder. Remember though, these permissions will apply to their home directory and below. You can have multiple admin users, who all have full permission to their own home directories. Leave only the FULL CONTROL box checked.
Read-only User
A read-only user is a user who can only connect, view files on the site and download. For this user you would uncheck FULL CONTROL, then check List and Download.
Upload User/Service Account
This would typically be a service account which would upload files with a unique naming convention in an automatic fashion. For this type of account you would uncheck FULL CONTROL, and check List, and Upload. If you also want the service user to also be able to overwrite the files within their home directory, check the Overwrite option. If the user should be allowed to also create folders under their home directory, check the Create Directories option. Without this permission, then can only create files within the root of their home directory, or within subfolders which already exist.
If you have any questions about how to configure your user's permission, please reach out to us on the contact page.
User Logs
These are logs kept for the individual user, which will include things such as failed logins, and file operations (all uploads, downloads, deletes, etc).
Delete User
If you delete a user, only the user's login is deleted. All files/folders from the user's home directory will be left in place. If necessary, files & folders will need to be cleaned up manually by an another user.
System Logs
System Logs is where you can view an administrator audit trail (adding/removing users), and other messages such as failed login attempts.
Getting Started with RunFTP
This article will guide you through the first few steps for configuring your account including choosing a URL, managing users and permissions and monitoring logs.