Apps can be installed from the
App Store menu item. Clicking on an app will display
information about the app.
Install button will show an install dialog:
Location field is the subdomain into which the app will be installed. Use the drop down
selector on the right to choose the domain into which the app will by installed.
If the subdomain field is empty, the app will be installed in the bare/naked domain (i.e
smartserver.space in the picture above).
Location field can be multi-level
Location field can be any level deep. For example, you can specify location as
blog.dev to make the app available at
Clicking on the gear button will open the app's configure view.
Changing the location field in the
Location section of the app's configure UI will move the app to
another domain or subdomain:
No data loss
Moving an app to a new location is a non-destructive action. Existing app data will be migrated to the new domain.
Aliases can be setup from the
Location section in the app's configure UI:
The alias feature is only enabled for select apps since it requires apps to support multiple domains. Notably apps like WordPress, EspoCRM, Surfer support this feature.
Redirections can be setup from the
Location section in the app's configure UI:
In the above example, anyone visiting
chat3.smartserver.io will be automatically
redirected to the main domain
chat.cloudron.ml (using HTTP 302).
The redirection feature preserves any URI components like subpaths in the original request.
Labels and Tags
Label is the text that is displayed for the app on the dashboard below the icon.
Tags are a
mechanism to tag apps with labels. For example, you can mark specific apps with the customer name
and filter apps by customer name.
The label and tag of an app can be changed in the
Display section of the app's configure UI:
All apps are run with a memory limit to ensure that no app can bring down the whole Cloudron. The default memory limit of an app is set by the app author at packaging time. This limit is usually the minimum amount of memory required for the app. Cloudron admins are expected to tweak the memory limit of an app based on their usage.
When an app runs out of memory, Cloudron automatically restarts it and sends an OOM email notification to Cloudron admins.
The memory limit can be set by adjusting the slider in the
of the app's configure view.
Memory limit includes swap
The memory limit specified above is a combination of RAM and swap space to be allocated for the app. Cloudron allocates 50% of this value as RAM and 50% as swap.
By default, all apps use as much CPU as they need. When CPU cycles are constrained, the CPU share setting determines how the linux kernel should share CPU usage across apps. The CPU share setting is a percentage relative to each app. It priorotizes CPU resources for the available CPU cycles. It does not reserve specific CPU access.
The CPU share can be set by adjusting the slider in the
of the app's configure view.
Many apps in Cloudron are integrated with Cloudron's user management. For such apps, one or more groups or users can be assigned to an app to restrict login. For apps not integrated with Cloudron user management, see the section on controlling the visibility of app icon in dashboard.
Note that Cloudron only handles authentication. Assigning roles to users is
done within the application itself. For example, changing a user to become a
author inside WordPress has to be done within WordPress.
Allow all users from this Cloudron- Any user in the Cloudron can access the app.
Only allow the following users and groups- Only the users and groups can access the app.
An admin can set user(s) & group(s) as the operators of an app. An app operator can perform configuration and maintanence tasks. Unlike an app admin, an operator cannot uninstall the app or change it's location. Operators cannot clone apps either because they do not have the permissions to install new apps.
An operator will see the gear icon on their dashboard:
On clicking the gear icon, they will see the operator UI:
The Dashboard of a Cloudron user displays the apps that the user can access. For apps that use Cloudron Single Sign-on, the dashboard only displays an app if the user has access to it.
For apps configured to not use the Cloudron Single Sign-on (for example, some public app like a
Forum or Chat), the apps are displayed (by default) on the dashboard of all users. Admins
can control if an app appears in a user's dashboard using the
Dashboard Visibility section
in the app's configure UI.
Apps store their data and assets in the
/home/yellowtent/appsdata/<appid> directory. If the
server is running out of disk space (in the root filesystem), you can move the app's storage
directory to another location. In most cases, this is an external disk mounted on the server. For example,
you can mount a DigitalOcean Block Storage or AWS Block Store
and move the app's data to that disk.
For example, to move an app's data to an external disk location like
/mnt/nextcloud, go to the
App Data Directory is backed up
The external app data directory is part of the app's backup.
Apps on Cloudron are containerized and do not have access to the server's file system. To provide an app access to a path on the server, one can create a Volume and then mount the volume into the app.
First, create a volume in the
Then, the volume can be mounted into one or more apps.
Volumes are mounted under the
/media directory of the app. In the example above, the app
can access music files from
/media/music (which corresponds to the host path
When the read only flag is checked, the
/media/music directory is not writable.
Mail FROM address
For apps that can send email, Cloudron automatically assigns an address of the
<location>.app. To change this name, go to the
For select apps, you can also disable email auto-configuration using
Do not configure app's mail delivery settings.
When selected, Cloudron will not configure email delivery settings inside the app, you can set it
This is not a mailbox, just an address
The app is simply configured to send mails with the above name. If you want to receive email with the address, be sure to create a mailbox. If a mailbox with the name does not exist, any replies to the email will bounce.
For apps that can receive email, the inbox address for the app can be assigned in the
When an inbox address is assigned, Cloudron will configure the app to receive mails using that address. It will also generate a dynamic username and password for the app to use to access the inbox.
An inbox address can only be assigned, if the email server for the domain in hosted on Cloudron. If the email server is external to Cloudron, use the "Do not configure inbox" option and configure the app on your own.
Mailbox must be manually created
The app is simply configured to receive mails with the above address. You must create a mailbox for emails to be received by the mail server.
Robots.txt file is a file served from the root of a website to indicate which parts must be indexed by a search
engine. The file follows the Robots Exclusion Standard.
Google has an excellent document about the semantics.
The robots.txt contents of an app can be set in the
Security section of the app's configure UI.
By default, Cloudron does not setup a robots.txt for apps. When unset, the app is free to provide it's own robots.txt.
In addition, the Cloudron admin page has a hardcoded robots.txt that disables indexing:
User-agent: * Disallow: /
Cron jobs required for the app to function are already integrated into the app package and no further
configuration is required. If you want to run additional custom cron commands, you can add them in the
Cron commands are run with the exact same context as the app (in a one-off container). This means that they have access to all the same environment and databases as the app itself. They also follow the life cycle states of the app. When an app is stopped, they don't run anymore. The log output of the cron commands can be viewed using the log viewer.
Cron times are specified in UTC.
The CSP HTTP header instructs the browser to only load scripts, media, images and other resources only from specific sites. Some apps set these headers to be overly restrictive and provide no way to customize them. For such apps, you can override the CSP headers set by the app.
For example, to embed Mattermost in another site, you can set the following CSP policy for Mattermost:
Cloudron provides a web terminal that gives access to the app's file system. The web terminal
can be used to introspect and modify the app's files, access the app's database etc. Note that
Cloudron runs apps as containers with a read-only file system. Only
/run (dynamic data),
/app/data (backup data) and
/tmp (temporary files) are writable.
The web terminal can be accessed using the Web Terminal button:
Clicking the icon will pop up a new window. The terminal is essentially a shell into the app's file system.
Cloudron provides a File Manager that be used to modify the app's file system from the browser.
The File Manager can be accessed using the File Manager button:
Clicking the icon will pop up a new window. Note that there are action like Rename, Delete, Change Ownership in the context menu.
Certain apps like WordPress, LAMP, Surfer support access to their data via SFTP. Files can be viewed
and uploaded using any SFTP client. The FTP connection information can be displayed by clicking
SFTP Access menu item.
A SFTP client like FileZilla can be used to connect as follows:
sftp://my.cloudron.space(host is the same for SFTP access to all apps)
firstname.lastname@example.org(username is different for SFTP access to each app)
Password- Cloudron password (password is the same for SFTP access to all apps)
Only Cloudorn admins have SFTP access. To give a specific user access to SFTP of a single app, make them an operator.
SFTP service runs at port 222. The server firewall already has this port open. However, you will
have to whitelist this port in the Cloud firewall (e.g EC2 Security Group or DigitalOcean Firewall).
If the domain is fronted by Cloudflare, use the IP address of the server to connect via SFTP instead
To view the logs of an app, click the logs button:
This will open up a popup dialog that display the logs:
When doing website development, it is useful to have production and staging environments. Cloudron's backup and clone features can be used to create a workflow as follows:
- Install the app in
staging.example.com. Do edits and development as desired.
- Once ready, make a 'snapshot' of the app by making an app backup
- Use the clone UI to install the app
The same mechanism above can be used bring latest production data to staging.
The Graphs view shows an overview of the disk and memory usage on your Cloudron.
Disk Usage graph shows you how much disk space you have left. Note that the Cloudron will
send the Cloudron admins an email notification when the disk is ~90% full.
Apps Memory graph shows the memory consumed by each installed app. You can click on each segment
on the graph to see the memory consumption over time in the chart below it.
System Memory graph shows the overall memory consumption on the entire Cloudron. If you see
the Free memory < 50MB frequently, you should consider upgrading to a Cloudron with more memory.
An app can be stopped using the Stop button from the app toolbar.
An app can be uninstalled clicking the
Uninstall button in the app's configure UI.
Uninstalling an app immediately removes all data associated with the app from the Cloudron.
Backups are not removed
App backups are not removed when it is uninstalled and are only cleaned up based on the backup policy. Apps can always be re-instated from their backups using the CLI tool.