Path reference

Below is a table that acts as an exhaustive reference for notable files you can find on a slot. Notable files are those where Feral has given them special meaning in some form. It does not include files created or used by programs running on the slot.

A newly created slot normally comes with a small number of files already present. For example there is a ~/www folder keeping the slot's associated domain. You may also note that software is generally installed under ~/private. While most of this structure is intended to be discoverable, this reference acts as a method to look up the precise meaning of files.

You do not need to know these files to use a slot effectively. It is intended to answer questions like "why is this file here" or "are there any related files?" It's perfectly fine, encouraged even, to make the slot your own and structure it how you wish, even if it means breaking a few things along the way.

Path File Docs Usage
~/ Folder - A slot's home folder.
~/.apache2 Folder - Contains files related to running Apache as the slot's HTTP server. Used as a fallback if no ~/.nginx is missing.
~/.apache2/.prevent-restart Empty file -
~/.apache2/conf.d Folder - Folder for Apache2 config. Addititive to the default (use nginx for full control).
~/.config/feral/ns/containers/name Folder - Configuration folder for the "slotns" container system. This provides processes with some degree of isolation.
~/.config/feral/ns/containers/name/root File - Contains the name of the OS used to launch the start script. Currently only takes the value debian-trixie or an empty string (the default if invalid or missing). An empty string does not use an alternate OS root.
~/.config/feral/ns/containers/name/start Executable file - Launch script to run in the slotns. Forked processes will be stopped once the script ends (avoid forking or daemon mode).
~/.config/feral/ns/forwarding/tcp Folder - Enables TCP port forwarding to the userns. A max of ten ports can be forwarded.
~/.config/feral/ns/forwarding/udp Folder - Enables UDP port forwarding to the userns. Same format as TCP forwarding.
~/.config/feral/ns/forwarding/tcp/port File containing destination port number - Forwards the public port (file name) to the destination port (file contents) in the userns. Must not specify system or used ports.
~/.config/feral/user-container.d/script Executable file - Runs a script in a container providing some degree of isolation. For more configuration options, use ~/.config/feral/ns/containers instead.
~/.cronscript.sh Executable file Cron Suggested example crontab script that enables control over auto-restart of programs.
~/.nginx Empty folder nginx install notes If this folder is empty, it will be automatically populated with the default nginx configuration.
~/.nginx Non-empty folder nginx If this folder is not empty, nginx will be used as a the slot's HTTP server. This overrides the ~/.apache2 folder. Default for all slots since
~/.nginx/.prevent-restart Empty file -
~/.nginx/php Folder - Files ending in .php under public_html will be executed by PHP rather than sending the file. This folder contains the configuration for PHP FPM.
~/.nginx/php/php.ini File - Settings for PHP. Restart PHP to reapply. The default is a symlink to the system version that cannot be edited. Replace with your own copy to modify.
~/.nginx/php/start File PHP version Script used to start up PHP. Allows a slot to use a specific version.
~/action.log Text file - Actions run by Feral's auto-restart on a slot.
~/private Folder - Base folder for most Feral-managed software (including those outside of it). Its presence enables the auto-restart and management.
~/private/deluge/.prevent-restart Empty file Restart Deluge Presence of this file stops the auto-restart mechanism for Deluge.
~/private/install-plex Text file Plex installation
~/private/install-plex.txt Text file Plex installation Same as ~/private/install-plex.
~/private/mysql/.prevent-restart Empty file Restart MySQL Presence of this file stops the auto-restart mechanism for MySQL.
~/private/plex
~/private/plex.login
~/private/plex.login.txt
~/private/plex/usr
~/private/plex/.prevent-restart
~/private/rtorrent/.prevent-restart Empty file Restart rTorrent Presence of this file stops the auto-restart mechanism for rtorrent.
~/private/rtorrent/.socket Socket - Expected location of rtorrent's SCGI socket. This is used by rutorrent, nginx and for periodic health checks.
~/private/rtorrent/work/rtorrent.lock Lock file - Expected location of rtorrent's lock file. A lock file prevents multiple instances of rtorrent on the same work or session folder. If rtorrent crashes this will be automatically cleaned up.
~/private/rtorrent/.version File rTorrent version
~/private/transmission/.prevent-restart Empty file Restart Transmission Presence of this file stops the auto-restart mechanism for Transmission.
~/www Folder HTTP Base folder for all domains on a slot.
~/www/example.com Folder (not a symlink) Domains Auto-configures example.com and *.example.com domain to your HTTP server. Replace example.com with your own domain. You must set DNS separately.
~/www/example.com/https.crt PEM certificate file HTTPS The contents must be a PEM certificate adhering to nginx's ssl_certificate directive.
~/www/example.com/https.key RSA key file HTTPS The contents must be an RSA key file adhering to nginx's ssl_certificate_key directive. Must be an RSA-based key. Must be the related key to the corresponding https.crt file.
~/www/example.com/public_html Folder or symlink - Intended as the root folder for the domain's public content to be served by HTTP. Content that never intended to served over HTTP should not be placed in this folder.
~/www/user.server.feralhosting.com Folder - Unique domain given to every slot. Replace user and server with your slot's username and associated server. Can be accessed from following URLs: http://user.server.feralhosting.com/ http://server.feralhosting.com/user/ and https://server.feralhosting.com/user/
~/www/user.server.feralhosting.com/public_html/rutorrent Folder ruTorrent Self-contained rutorrent installation and configuration. This is a web frontend for rtorrent.
~/www/user.server.feralhosting.com/public_html/rutorrent/plugins Folder ruTorrent plugins Plugin folder for rutorrent. Installed plugins must match the rutorrent version (found in the titlebar).