#!/bin/bash #################################################################################################### #### author: SlickStack ############################################################################ #### link: https://slickstack.io ################################################################### #### mirror: http://mirrors.slickstack.io/bash/ss-config-sample.txt ################################ #### path: /var/www/ss-config-sample (for reference only) ########################################## #### destination: /var/www/ss-config (can be configured by ss-install wizard or manually) ########## #### purpose: SlickStack configuration file ######################################################## #### module version: Ubuntu 20.04 LTS ############################################################## #### bash aliases: n/a ############################################################################# #################################################################################################### ## TO UPDATE SS-CONFIG TO LATEST BOILERPLATE RUN SS-UPDATE (ALL SETTINGS ARE RETAINED) ## ## AFTER CHANGING ANY SS-CONFIG SETTINGS BELOW YOU MUST RUN SS-INSTALL AGAIN ## #################################################################################################### #### SlickStack: SS-Config Build Version (Checked By SS-Install) ################################### #################################################################################################### ## run ss-update if ss-config outdated: https://mirrors.slickstack.io/ss-config-sample.txt ## ## or copy and paste entire ss-config boilerplate before modifying any options ## SS_BUILD="JAN2021B" #################################################################################################### #### SS-Config: Root + Sudo User Settings ########################################################## #################################################################################################### ## write down your sudo password or you will be locked out of your server forever ## ## after ss-install completes the root user will have no shell access ## ## ROOT_PASSWORD = [*must be unique*] choose something very strong as you won't use this ## ## SUDO_USER = [*must be unique*] something that you can remember for shell logins ## ## SUDO_PASSWORD = [*must be unique*] write this down because you will need it ## ROOT_PASSWORD="@ROOT_PASSWORD" SUDO_USER="@SUDO_USER" SUDO_PASSWORD="@SUDO_PASSWORD" ## using SSH keys is only recommended for advanced users who know what they are doing ## ## be sure to copy your public key into: /var/www/meta/.ssh/authorized_keys ## ## SSH_PORT = [6969|22|etc] best not to use port 22 for increased shell security ## ## SSH_KEYS = [false|true] for expert users only (this will disable password logins) ## SSH_PORT="@SSH_PORT" SSH_KEYS="@SSH_KEYS" #################################################################################################### #### SS-Config: SFTP User Settings (Jailed To SlickStack Root) ##################################### #################################################################################################### ## SFTP user is jailed to the /var/www/ directory e.g. for your client to safely access ## ## you can also use the SFTP user for remote backups (safer than sudo user) ## ## SFTP_USER = [*must be unique*] username that your client can login as via SFTP ## ## SFTP_PASSWORD = [*must be unique*] something strong but not too complex or confusing ## SFTP_USER="@SFTP_USER" SFTP_PASSWORD="@SFTP_PASSWORD" #################################################################################################### #### SS-Config: Database Settings (Production Site) ################################################ #################################################################################################### ## using a remote MySQL database has not been extensively tested (use at your own risk) ## ## for security reasons choose a different password for the MySQL root user ## ## DB_NAME = [wordpress|etc] only one production database (along with _staging and _dev) ## ## DB_USER = [example|etc] for easier management it can be the same as SFTP_USER ## ## DB_PASSWORD = [*must be unique*] something strong but not too complex or confusing ## ## DB_PASSWORD_ROOT = [*must be unique*] now only used for admin@127.0.0.1 ## ## DB_HOST = [127.0.0.1|111.222.333.444|etc] if using a remote database server enter here ## ## DB_PREFIX = [wp_|etc] for easier management the default wp_ prefix recommended ## ## DB_CHARSET = [utf8mb4|etc] most databases these days should be using utf8mb4 ## ## DB_COLLATE = [NULL|etc] leave it blank unless you really know what you are doing ## DB_NAME="@DB_NAME" DB_USER="@DB_USER" DB_PASSWORD="@DB_PASSWORD_USER" DB_PASSWORD_ROOT="@DB_PASSWORD_ROOT" DB_HOST="@DB_HOST" DB_PREFIX="@DB_PREFIX" DB_CHARSET="utf8mb4" DB_COLLATE="" #################################################################################################### #### SS-Config: Site Domain Settings (Subdirectories Not Allowed) ################################## #################################################################################################### ## below domain values are used in order to hardcode Nginx and WordPress configuration ## ## database domain settings will have no effect after the ss-install completes ## ## SITE_TLD = [example.com] w/o prefixes (required for all WP installations) ## ## SITE_DOMAIN = [www.example.com|sub.example.com] w/o suffixes (for WP single sites) ## ## SITE_NOINDEX = [false|true] Nginx header (noindex + nofollow + noarchive + nosnippet) ## SITE_TLD="@SITE_TLD" SITE_DOMAIN="@SITE_DOMAIN" SITE_NOINDEX="@SITE_NOINDEX" #################################################################################################### #### SS-Config: CloudFlare API + Related Settings (MU Plugin) ###################################### #################################################################################################### ## these settings are to control CloudFlare from the WP Admin for easier management ## ## for better security and optimal performance use the recommended settings ## ## CLOUDFLARE_API_KEY = [*must be unique*] find your API key in your CloudFlare account ## ## CLOUDFLARE_API_EMAIL = [*must be unique*] the email address of your CloudFlare account ## ## CLOUDFLARE_WIDGET_DNS = [true|false] if you want to see DNS records in WP Admin ## ## CLOUDFLARE_WIDGET_ANALYTICS = [true|false] if you want traffic stats in WP Admin ## ## CLOUDFLARE_RECOMMENDED_SETTINGS = [true|false] hardcodes certain CloudFlare settings ## CLOUDFLARE_API_KEY="@CLOUDFLARE_API_KEY" CLOUDFLARE_API_EMAIL="@CLOUDFLARE_API_EMAIL" CLOUDFLARE_WIDGET_DNS="true" # CLOUDFLARE_WIDGET_ANALYTICS="true" # CLOUDFLARE_RECOMMENDED_SETTINGS="true" #################################################################################################### #### SS-Config: Native Staging Site + Dev Site Settings (Both Optional) ############################ #################################################################################################### ## STAGING_SITE = [true|false] enables staging site and WP Admin toolbar switcher ## ## STAGING_SITE_SUBDOMAIN = [false|true] if you want staging site to load as subdomain ## ## STAGING_REPLACE_LINKS_DB = [high|low|false] how aggressive to fix MySQL links ## ## STAGING_REPLACE_LINKS_THEME = [high|low|false] how aggressive to fix hardcode links ## STAGING_SITE="@STAGING_SITE_STATUS" STAGING_SITE_SUBDOMAIN="true" # STAGING_REPLACE_LINKS_DB="high" # STAGING_REPLACE_LINKS_THEME="high" ## DEV_SITE = [true|false] enables dev site and WP Admin toolbar switcher ## ## DEV_SITE_SUBDOMAIN = [false|true] if you want dev site to load as subdomain ## DEV_SITE="@DEV_SITE_STATUS" DEV_SITE_SUBDOMAIN="true" #################################################################################################### #### SS-Config: Remote Backup (Via SFTP/API) Settings ############################################## #################################################################################################### ## not to be confused with the ss-dump script which creates a temporary local archive ## ## remote backups (ss-backup) push your SlickStack files to a remote server ## ## BACKUP_SERVICE = [dropbox|backblaze|etc] ## BACKUP_API_KEY ## BACKUP_USER ## BACKUP_PASSWORD #################################################################################################### #################################################################################################### #################################################################################################### #################################################################################################### ######## ADVANCED SETTINGS BELOW (MOST SLICKSTACK SERVERS SHOULD NOT CHANGE THESE) ################# #################################################################################################### #################################################################################################### #################################################################################################### #################################################################################################### ## most websites should be fine using the default settings that are pre-configured below ## ## only advanced users with sysadmin experience should mess around with these ## #################################################################################################### #### SS-Config: Select WordPress + WP-Config Settings ############################################## #################################################################################################### ## by default wp-cron will be managed entirely by WordPress unless you modify it here ## ## if set to server then ss core cron jobs will take over wp-cron management ## ## WP_CRON_METHOD = [wordpress|server] change to server for ss core cron jobs to manage it ## ## WP_CRON_INTERVAL = [often|regular|quarter-hourly|half-hourly|hourly|quarter-daily|half-daily|daily] ## WP_CRON_METHOD="wordpress" WP_CRON_INTERVAL="quarter-hourly" ## Multisite setups should not be used for high-traffic or business-critical websites ## ## domain mapping on Multisite installations requires the subdomains approach ## ## WP_MULTISITE = [false|true] enables WP Multisite using the same directory structure ## ## WP_MULTISITE_SUBDOMAINS = [true|false] subdomains approach highly recommended ## ## WP_MULTISITE_DOMAIN_MAPPING = [false|true] hosting multiple TLD domains not recommended ## WP_MULTISITE="false" WP_MULTISITE_SUBDOMAINS="true" WP_MULTISITE_DOMAIN_MAPPING="false" ## for stability reasons several WP defined constants are hard-coded in the wp-config ## ## define additional constants using the included Custom Functions MU plugin ## ## WP_POST_REVISIONS = [3|5|10|etc] the smaller the better but >1 to avoid data loss ## ## WP_AUTOSAVE_INTERVAL = [15|30|60|120|etc] less often saves resources but risks data loss ## ## WP_HTTP_BLOCK_EXTERNAL = [false|true] best for typical users to keep this disabled ## ## WP_ACCESSIBLE_HOSTS = [api.wordpress.org,example.com,etc] comma separated allowed hosts ## ## WP_DISALLOW_FILE_EDIT = [false|true] prevents editing plugin/theme files in WP Admin ## ## WP_DISALLOW_FILE_MODS = [false|true] prevents all core/plugin/theme updates and changes ## ## WP_ALLOW_UNFILTERED_UPLOADS = [true|false] interactive communities should not allow ## WP_POST_REVISIONS="3" WP_AUTOSAVE_INTERVAL="60" WP_HTTP_BLOCK_EXTERNAL="false" WP_ACCESSIBLE_HOSTS="api.wordpress.org" WP_DISALLOW_FILE_EDIT="false" WP_DISALLOW_FILE_MODS="false" WP_ALLOW_UNFILTERED_UPLOADS="true" #################################################################################################### #### SS-Config: OpenSSL + Lets Encrypt Settings (CSR Optional) ##################################### #################################################################################################### ## some of the below SSL settings only apply to either OpenSSL or Lets Encrypt certs ## ## to avoid confusion we maintain all SSL related settings in the same place ## ## SSL_TYPE = [openssl|certbot] OpenSSL is easier to manage (CloudFlare required if chosen) ## ## SSL_PROTOCOLS = [TLSv1.2 TLSv1.3|etc] for PCI standards etc best to use 1.2 + 1.3 ## ## SSL_SESSION_TIMEOUT = [120m|360m|1d|etc] less sensitive sites can use a higher setting ## ## SSL_SESSION_CACHE = [shared:SSL:64m] there should be no reason to use other settings ## ## SSL_BUFFER_SIZE = [4K|8k|16k] smaller is better but less than 16k can cause errors ## SSL_TYPE="@SSL_TYPE" SSL_PROTOCOLS="TLSv1.2 TLSv1.3" SSL_CIPHERS="ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384" SSL_SESSION_TIMEOUT="1d" SSL_SESSION_CACHE="shared:SSL:64m" SSL_BUFFER_SIZE="16k" ## CSR_COUNTRY = [US|etc] country to be used with your SSL CSR request data ## ## CSR_STATE = [Nevada|etc] state or province to be used with your SSL CSR request data ## ## CSR_CITY = [Las Vegas|etc] city or town to be used with your SSL CSR request data ## ## CSR_COMPANY = [Example, LLC|etc] company name to be used with your SSL CSR request data ## ## CSR_DEPT = [DevOps|etc] department to be used with your SSL CSR request data ## CSR_COUNTRY="US" CSR_STATE="Nevada" CSR_CITY="Las Vegas" CSR_COMPANY="Example, LLC" CSR_DEPT="DevOps" ## CERTBOT_CHALLENGE_TYPE = [http|dns] which method of verifying your domain do you want ## ## ...ss-install wizard would need to pause or something if DNS verify chosen? #################################################################################################### #### SS-Config: Select Nginx + Open File Cache Settings ############################################ #################################################################################################### ## default Nginx settings assume that CloudFlare is in front of your origin VPS server ## ## this means that most settings are very liberal to allow for traffic scaling ## ## NGINX_MODULES = ## NGINX_WORKER_RLIMIT_NOFILE = ## NGINX_WORKER_CONNECTIONS = ## NGINX_SERVER_NAMES_HASH_BUCKET_SIZE = ## NGINX_SERVER_NAMES_MAX_HASH_SIZE = ## NGINX_TYPES_MAX_HASH_SIZE = ## NGINX_CLIENT_MAX_BODY_SIZE = ## NGINX_CLIENT_BODY_BUFFER_SIZE = ## NGINX_CLIENT_HEADER_BUFFER_SIZE = ## NGINX_LARGE_CLIENT_HEADER_BUFFERS = ## NGINX_CLIENT_BODY_TIMEOUT = ## NGINX_CLIENT_HEADER_TIMEOUT = ## NGINX_KEEPALIVE_TIMEOUT = ## NGINX_KEEPALIVE_REQUESTS = ## NGINX_SEND_TIMEOUT = NGINX_WORKER_RLIMIT_NOFILE="65535" NGINX_WORKER_CONNECTIONS="8192" NGINX_SERVER_NAMES_HASH_BUCKET_SIZE="64" NGINX_SERVER_NAMES_MAX_HASH_SIZE="512" NGINX_TYPES_MAX_HASH_SIZE="2048" NGINX_CLIENT_MAX_BODY_SIZE="512M" NGINX_CLIENT_BODY_BUFFER_SIZE="16k" NGINX_CLIENT_HEADER_BUFFER_SIZE="4k" NGINX_LARGE_CLIENT_HEADER_BUFFERS="4 64k" NGINX_CLIENT_BODY_TIMEOUT="15s" NGINX_CLIENT_HEADER_TIMEOUT="15s" NGINX_KEEPALIVE_TIMEOUT="90s" NGINX_KEEPALIVE_REQUESTS="65535" NGINX_SEND_TIMEOUT="120s" ## NGINX_HEADER_POWERED_BY = ## NGINX_HEADER_STRICT_TRANSPORT_SECURITY = ## NGINX_HEADER_REFERRER_POLICY = ## NGINX_HEADER_PERMISSIONS_POLICY = ## NGINX_HEADER_FEATURE_POLICY = NGINX_HEADER_POWERED_BY="SlickStack" NGINX_HEADER_STRICT_TRANSPORT_SECURITY="max-age=15552000" ## 180 days (always) NGINX_HEADER_REFERRER_POLICY="strict-origin-when-cross-origin" NGINX_HEADER_PERMISSIONS_POLICY="accelerometer=(), ambient-light-sensor=(), autoplay=*, battery=(), camera=(), display-capture=*, document-domain=*, encrypted-media=*, fullscreen=*, geolocation=(self), gyroscope=(), layout-animations=*, legacy-image-formats=*, magnetometer=(), microphone=(self), midi=(), oversized-images=*, payment=*, picture-in-picture=*, publickey-credentials-get=*, sync-xhr=*, usb=(), vibrate=(), wake-lock=(), xr-spatial-tracking=()" NGINX_HEADER_FEATURE_POLICY="ambient-light-sensor none; animations self; autoplay none; accelerometer none; camera none; display-capture none; document-domain none; document-write none; encrypted-media none; fullscreen self; geolocation none; gyroscope none; image-compression *; legacy-image-formats *; magnetometer none; max-downscaling-image *; microphone none; midi none; notifications self; payment none; picture-in-picture self; push none; speaker self; sync-xhr none; unsized-media *; usb none; vertical-scroll self; wake-lock none; webauthn none; vibrate none; vr none; xr-spatial-tracking none;" ## OPEN_FILE_CACHE_MAX = ## OPEN_FILE_CACHE_INACTIVE = ## OPEN_FILE_CACHE_VALID = ## OPEN_FILE_CACHE_MIN_USES = ## OPEN_FILE_CACHE_ERRORS = OPEN_FILE_CACHE_MAX="200000" OPEN_FILE_CACHE_INACTIVE="20s" OPEN_FILE_CACHE_VALID="30s" OPEN_FILE_CACHE_MIN_USES="2" OPEN_FILE_CACHE_ERRORS="on" #################################################################################################### #### SS-Config: FastCGI Cache (Nginx) + TMPFS (RAM Disk) Settings ################################## #################################################################################################### ## nearly every WordPress site should be using FastCGI Cache at least for micro-caching ## ## Nginx pre-configured to skip cache on /cart* /checkout* /account* pages (etc) ## ## FCGI_CACHE = [true|false] recommended for nearly every WordPress site ## ## FCGI_CACHE_VALID = [60m|1440m|etc] longer is better (but dynamic sites need less) ## ## FCGI_CACHE_INACTIVE = [60m|1440m|etc] longer is better (but dynamic sites need less) ## ## FCGI_CACHE_MEMORY = [64m|128m|256m|512m|etc] for 512M|1GB|2GB|4GB RAM VPS ## ## FCGI_CACHE_MAX_SIZE = [2048m|4096m|8192m|16384m|etc] allocate space on disk ## ## FCGI_CACHE_QUERIES = ## FCGI_CACHE_QUERIES_SEARCH = ## FCGI_CACHE_TMPFS = [false|true] mount as TMPFS (not recommended) ## ## FCGI_CONNECT_TIMEOUT = ## FCGI_READ_TIMEOUT = ## FCGI_SEND_TIMEOUT = ## FCGI_BUFFERS = ## FCGI_BUFFER_SIZE = ## FCGI_BUSY_BUFFERS_SIZE = ## FCGI_TEMP_FILE_WRITE_SIZE = FCGI_CACHE="true" FCGI_CACHE_VALID="1440m" FCGI_CACHE_INACTIVE="1440m" FCGI_CACHE_MEMORY="256m" FCGI_CACHE_MAX_SIZE="4096m" FCGI_CACHE_TMPFS="false" FCGI_CONNECT_TIMEOUT="60s" FCGI_READ_TIMEOUT="60s" FCGI_SEND_TIMEOUT="60s" FCGI_BUFFERS="32 32k" FCGI_BUFFER_SIZE="32k" FCGI_BUSY_BUFFERS_SIZE="256k" FCGI_TEMP_FILE_WRITE_SIZE="256k" # FCGI_CACHE_QUERIES="true" # FCGI_CACHE_QUERIES_SEARCH="true" #################################################################################################### #### SS-Config: MySQL + InnoDB Settings (Applies To Localhost Database Only) ####################### #################################################################################################### ## there are very few settings that need to be optimized in MySQL after version 5.7+ ## ## probably the SQL_MODE is the only setting that you might consider changing ## ## SQL_MODE = [*infinite options*] the preset mode is highly recommended ## ## SQL_MAX_ALLOWED_PACKET = [256M|1GB|etc] a high number helps avoid staging/backup issues ## ## SQL_CONNECT_TIMEOUT = [15|30|60|3600|etc] time allowed to establish a connection ## ## SQL_WAIT_TIMEOUT = [30|60|3600|28800|etc] usually this can be a fairly small number ## ## SQL_INTERACTIVE_TIMEOUT = [1800|3600|28800|43200|etc] larger to support applications etc ## ## SQL_NET_READ_TIMEOUT = [30|60|3600|etc] usually this should be fine at 30 seconds ## ## SQL_NET_WRITE_TIMEOUT = [30|60|3600|etc] usually this should be fine at 60 seconds ## SQL_MODE="STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION" SQL_MAX_ALLOWED_PACKET="1GB" SQL_CONNECT_TIMEOUT="60" SQL_WAIT_TIMEOUT="3600" SQL_INTERACTIVE_TIMEOUT="43200" SQL_NET_READ_TIMEOUT="3600" SQL_NET_WRITE_TIMEOUT="3600" ## INNODB_BUFFER_POOL_SIZE = [auto|256M|512M|1GB|2GB|4GB|etc] ~50-70% of total RAM ## ## INNODB_LOG_FILE_SIZE = [256M|512M|1GB|etc] bigger is better but slows crash recovery ## ## INNODB_LOG_FILES_IN_GROUP = [1|2|etc] debated but 1 is usually best ## ## INNODB_FLUSH_LOG_AT_TRX_COMMIT = [true|false] be a good boy and leave it on ## ## INNODB_FLUSH_METHOD = most servers should use O_DIRECT flushing ## INNODB_BUFFER_POOL_SIZE="auto" INNODB_LOG_FILE_SIZE="256M" INNODB_LOG_FILES_IN_GROUP="1" INNODB_FLUSH_LOG_AT_TRX_COMMIT="true" INNODB_FLUSH_METHOD="O_DIRECT_NO_FSYNC" #################################################################################################### #### SS-Config: General PHP Settings ############################################################### #################################################################################################### ## here you can customize the PHP extensions that are installed as part of PHP-FPM ## ## some PHP extensions like fpm, mysql are required for your CMS to function ## ## PHP_EXTENSIONS = [*extensions separated by spaces*] ## PHP_EXTENSIONS="php7.4-fpm php7.4-bcmath php7.4-curl php7.4-gd php7.4-imagick php7.4-json php7.4-mbstring php7.4-mysql php7.4-soap php7.4-xml php7.4-zip" ## many well-known PHP settings are hardcoded to ensure server stability and security ## ## below settings can be modified before ss-install to customize PHP as needed ## ## PHP_PRECISION = [14|etc] not many reasons to change from default value ## ## PHP_OUTPUT_BUFFERING = [4096|etc] keep in mind zlib.output_compression is disabled ## ## PHP_UNSERIALIZE_MAX_DEPTH = [4096|etc] new max depth setting for PHP 7.4 ## ## PHP_SERIALIZE_PRECISION = [-1|100|etc] only for uncommon situations ## ## PHP_DISABLE_FUNCTIONS = [*infinite options*] disable certain unsafe PHP functions ## ## PHP_DISABLE_CLASSES = [*infinite options*] disable certain unsafe PHP classes ## ## PHP_MAX_EXECUTION_TIME = [30|60|120|300|etc] most websites should use 30-60 ## ## PHP_MAX_INPUT_TIME = [30|60|120|300|etc] most websites should use 30-60 ## ## PHP_MAX_INPUT_NESTING_LEVEL = [64|etc] not many reasons to change default value (64) ## ## PHP_MAX_INPUT_VARS = [3000|5000|10000|etc] mostly to support extremely bloated themes ## ## PHP_MEMORY_LIMIT = [256M|512M|etc] should probably be 512M for most websites ## ## PHP_POST_MAX_SIZE = [256M|512M|etc] limit the size of post data ## ## PHP_UPLOAD_MAX_FILESIZE = [256M|512M|1024M|etc] limit the size of large uploads ## ## PHP_MAX_FILE_UPLOADS = [10|100|1000|etc] more relevant for community websites ## ## PHP_ALLOW_URL_FOPEN = [true|false] safe for most sites to keep this enabled ## ## PHP_DEFAULT_SOCKET_TIMEOUT = [60|etc] not many reasons to change this ## PHP_PRECISION="14" PHP_OUTPUT_BUFFERING="4096" PHP_UNSERIALIZE_MAX_DEPTH="4096" ## PHP 7.4+ PHP_SERIALIZE_PRECISION="-1" PHP_DISABLE_FUNCTIONS="" PHP_DISABLE_CLASSES="" PHP_MAX_EXECUTION_TIME="60" PHP_MAX_INPUT_TIME="60" PHP_MAX_INPUT_NESTING_LEVEL="64" PHP_MAX_INPUT_VARS="5000" PHP_MEMORY_LIMIT="512M" PHP_POST_MAX_SIZE="512M" PHP_UPLOAD_MAX_FILESIZE="512M" PHP_MAX_FILE_UPLOADS="100" PHP_ALLOW_URL_FOPEN="true" PHP_DEFAULT_SOCKET_TIMEOUT="60" #################################################################################################### #### SS-Config: FastCGI Process Manager Settings (PHP-FPM) ######################################### #################################################################################################### ## the vast majority of SlickStack servers should not need to adjust any FPM settings ## ## in most cases the php.ini settings and www.conf settings are more relevant ## ## FPM_EMERGENCY_RESTART_THRESHOLD = [10|15|30|etc] keep enabled with reasonable value ## ## FPM_EMERGENCY_RESTART_INTERVAL = [1m|etc] keep it at 1m if you don't know ## ## FPM_PROCESS_CONTROL_TIMEOUT = [10|etc] keep it at 10 if you don't know ## ## FPM_PROCESS_MAX = [128|etc] only experts should modify this value ## ## FPM_PROCESS_PRIORITY = [-19|etc] only experts should modify this value ## ## FPM_RLIMIT_FILES = [1024|etc] 1024 is good for most sites ## ## FPM_RLIMIT_CORE = [0|etc] almost nobody should be changing this from 0 ## ## FPM_SYSTEMD_INTERVAL = [0|10|etc] most sites 10 is good but set 0 for small boost ## FPM_EMERGENCY_RESTART_THRESHOLD="10" FPM_EMERGENCY_RESTART_INTERVAL="1m" FPM_PROCESS_CONTROL_TIMEOUT="10s" FPM_PROCESS_MAX="128" FPM_PROCESS_PRIORITY="-19" FPM_RLIMIT_FILES="65535" FPM_RLIMIT_CORE="0" FPM_SYSTEMD_INTERVAL="10" #################################################################################################### #### SS-Config: WWW Pool Settings ################################################################## #################################################################################################### ## MODULE VERSION: PHP-FPM 7.4.x ## modifying this tiny file can have drastic effects on scaling LEMP to high traffic ## ## ondemand is more efficient for most servers, be very careful tuning these ## ## WWW_LISTEN_BACKLOG = [65535|etc] most sites can leave this uncapped (e.g. 65535) ## ## WWW_PM_MODE = [ondemand|dynamic] dynamic for extremely high traffic (upgrade your VM) ## ## WWW_PM_MAX_CHILDREN = [20|etc] really depends on the rest of the settings you choose ## ## WWW_PM_START_SERVERS = [2|etc] keeping this number small usually makes more sense ## ## WWW_PM_MIN_SPARE_SERVERS = [1|etc] keep this at 1 to maximize CPU efficiency ## ## WWW_PM_MAX_SPARE_SERVERS = [3|etc] should usually be greater than PM_START_SERVERS ## ## WWW_PM_PROCESS_IDLE_TIMEOUT = [10s|etc] keep it small to avoid CPU resource abuse ## ## WWW_PM_MAX_REQUESTS = [500|etc] usually can keep it big if other settings are sensible ## ## WWW_REQUEST_TERMINATE_TIMEOUT = [300|etc] backup timeout if IDLE_TIMEOUT not applied ## ## WWW_RLIMIT_FILES = [65535|etc] most sites can leave this uncapped (e.g. 65535) ## ## WWW_RLIMIT_CORE = [0|etc] most sites can keep this disabled (e.g. 0) ## WWW_LISTEN_BACKLOG="65535" WWW_PM_MODE="ondemand" WWW_PM_MAX_CHILDREN="20" WWW_PM_START_SERVERS="2" WWW_PM_MIN_SPARE_SERVERS="1" WWW_PM_MAX_SPARE_SERVERS="3" WWW_PM_PROCESS_IDLE_TIMEOUT="10s" WWW_PM_MAX_REQUESTS="500" WWW_REQUEST_TERMINATE_TIMEOUT="300" WWW_RLIMIT_FILES="65535" WWW_RLIMIT_CORE="0" #################################################################################################### #### SS-Config: OPcache Settings (Always Enabled On Production Servers) ############################ #################################################################################################### ## MODULE VERSION: PHP-FPM 7.4.x ## OPcache is one of the most powerful (and underrated) ways to scale cheap VPS servers ## ## high traffic sites that understand how it works can adjust it with big results ## ## OPCACHE_MEMORY_CONSUMPTION = [128|256|512|etc] how much RAM that OPcache can use ## ## OPCACHE_INTERNED_STRINGS_BUFFER = [16|32|64|etc] probably keep this at 64 ## ## OPCACHE_MAX_ACCELERATED_FILES = [10000|1000000|etc] must be between 200-1000000 files ## ## OPCACHE_MAX_WASTED_PERCENTAGE = [5|10|15|20|etc] careful not to set this too high ## ## OPCACHE_REVALIDATE_FREQUENCY = [2|15|60|etc] seconds before cache checks for changes ## ## OPCACHE_HUGE_CODE_PAGES = [false|true] enable Huge Pages (not recommended) ## OPCACHE_MEMORY_CONSUMPTION="256" OPCACHE_INTERNED_STRINGS_BUFFER="64" OPCACHE_MAX_ACCELERATED_FILES="10000" OPCACHE_MAX_WASTED_PERCENTAGE="5" OPCACHE_REVALIDATE_FREQUENCY="2" OPCACHE_HUGE_CODE_PAGES="false" # OPCACHE_FILE_CACHE_ONLY="false" # OPCACHE_PRELOAD="false" ## PHP 7.4+ # etc with new 7.4 options #################################################################################################### #### SS-Config: General SlickStack Settings + Config Files Sources ################################# #################################################################################################### ## MODULE VERSION: Ubuntu 20.04 LTS ## SS_APP = [wordpress] only wordpress currently supported (suggestion? tell us!) ## ## SS_TIMEZONE = [UTC|Greenwich|etc] almost nobody should have a reason to not use UTC ## ## SS_MYSQL = [true|false] skips MySQL install if false (e.g. if using remote database) ## ## SS_MU_PLUGINS = [default|custom] use default LittleBizzy MU plugins or custom ones ## ## SS_REBOOT = [false|true] server will reboot automatically after ss-update runs ## SS_APP="@SS_APP" SS_DASHBOARD="true" # SS_MYSQL="true" ## pending SS_MU_PLUGINS="default" SS_PLUGIN_BLACKLIST="true" SS_REBOOT="false" SS_TIMEZONE="UTC" ## whitelabeling allows agencies to replace any SlickStack branding with their own ## ## this is useful for running your own web hosting business or otherwise ## # SS_WHITELABEL_BRAND="ACME Agency" # SS_WHITELABEL_HOMEPAGE="https://example.com" ## SS_DUMP_MYSQL_DB = [true|false] enable to mysqldump your database to /meta/ ## ## SS_DUMP_MYSQL_FILES = [false|true] only enable if you have tons of free disk space ## SS_DUMP_MYSQL_DB="true" SS_DUMP_MYSQL_FILES="false" ## there are a few cleanup related options during wordpress core installation ## ## keeping these enabled can help remove outdated or dangerous PHP files ## ## SS_INSTALL_WORDPRESS_CORE_DELETE_BUNDLED_PLUGINS ## SS_INSTALL_WORDPRESS_CORE_DELETE_BUNDLED_THEMES ## SS_INSTALL_WORDPRESS_CORE_DELETE_PHP_FILES_ROOT ## SS_INSTALL_WORDPRESS_CORE_DELETE_PHP_FILES_WP_CONTENT ## SS_INSTALL_WORDPRESS_CORE_DELETE_WP_ADMIN ## SS_INSTALL_WORDPRESS_CORE_DELETE_WP_INCLUDES SS_INSTALL_WORDPRESS_CORE_DELETE_BUNDLED_PLUGINS="true" SS_INSTALL_WORDPRESS_CORE_DELETE_BUNDLED_THEMES="true" SS_INSTALL_WORDPRESS_CORE_DELETE_PHP_FILES_ROOT="true" # SS_INSTALL_WORDPRESS_CORE_DELETE_PHP_FILES_WP_CONTENT="true" SS_INSTALL_WORDPRESS_CORE_DELETE_WP_ADMIN="true" SS_INSTALL_WORDPRESS_CORE_DELETE_WP_INCLUDES="true" # SS_CLEAN_PHP_HACKS="true" # SS_CLEAN_BACKUPS="true" ## MODULE VERSION: WordPress 5.5.x ## for custom configuration use the below settings to define configuration file sources ## ## source files must be publicly accessible via wget over either HTTP or HTTPS ## PLUGIN_BLACKLIST_SOURCE="http://mirrors.slickstack.io/wordpress/blacklist.txt" CUSTOM_FUNCTIONS_SOURCE="http://mirrors.slickstack.io/wordpress/functions.txt" THROWAWAY_THEME_SOURCE="http://mirrors.slickstack.io/wordpress/throwaway.zip" #################################################################################################### #### SS-Config: SlickStack Core Cron Job Schedules (Interval Settings) ############################# #################################################################################################### ## MODULE VERSION: Ubuntu 20.04 LTS ## modifying the below SlickStack intervals could affect server stability and updates ## ## disable any given cron job by setting interval to random string e.g. never ## ## [often|regular|quarter-hourly|half-hourly|hourly|quarter-daily|half-daily|daily|half-weekly|weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_CHECK = [often|regular|quarter-hourly|half-hourly|hourly] ## ## SS_INTERVAL_CLEAN_FILES = [hourly|quarter-daily|half-daily|daily|half-weekly|weekly] ## ## SS_INTERVAL_DOS2UNIX = [half-daily|daily|half-weekly|weekly|half-monthly] ## ## SS_INTERVAL_DUMP_DATABASE = [often|regular|quarter-hourly|half-hourly|hourly|quarter-daily|half-daily|daily] ## ## SS_INTERVAL_ENCRYPT = [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_OPTIMIZE_DATABASE = [daily|half-weekly|weekly|half-monthly|monthly] ## ## SS_INTERVAL_PERMS = [hourly|quarter-daily|half-daily|daily] ## ## SS_INTERVAL_PURGE = [quarter-daily|half-daily|daily|half-weekly|weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_REBOOT = [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_REMOTE = [half-daily|daily|half-weekly|weekly|half-monthly] ## ## SS_INTERVAL_RESET_PASSWORD [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_RESTART_SERVICES = [quarter-daily|half-daily|daily|half-weekly|weekly|half-monthly|monthly] ## ## SS_INTERVAL_SCAN_MALWARE = [daily|half-weekly|weekly|half-monthly] ## ## SS_INTERVAL_SYNC_STAGING = [hourly|quarter-daily|half-daily|daily|half-weekly] ## ## SS_INTERVAL_UPDATE = [half-monthly|monthly|sometimes] ## ## SS_INTERVAL_WORKER = [regular|quarter-hourly|half-hourly|hourly|quarter-daily] ## SS_INTERVAL_CHECK="often" SS_INTERVAL_CLEAN_FILES="half-daily" SS_INTERVAL_DOS2UNIX="half-weekly" SS_INTERVAL_DUMP_DATABASE="hourly" SS_INTERVAL_ENCRYPT="sometimes" SS_INTERVAL_OPTIMIZE_DATABASE="weekly" SS_INTERVAL_PERMS="quarter-daily" SS_INTERVAL_REBOOT="monthly" SS_INTERVAL_REMOTE="never" SS_INTERVAL_RESET_PASSWORD="never" SS_INTERVAL_RESTART_SERVICES="never" SS_INTERVAL_PURGE="monthly" SS_INTERVAL_SCAN_MALWARE="weekly" SS_INTERVAL_SYNC_STAGING="half-daily" SS_INTERVAL_UPDATE="never" SS_INTERVAL_WORKER="regular" ## below you can schedule ss-install subscripts (ss-install itself cannot be scheduled) ## ## this can help to ensure no infected or modifed core files in certain cases ## ## [often|regular|quarter-hourly|half-hourly|hourly|quarter-daily|half-daily|daily|half-weekly|weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_INSTALL_ADMINER = [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_INSTALL_CLAMAV = [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_INSTALL_MYSQL = [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_INSTALL_NGINX = [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_INSTALL_PHP = [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_INSTALL_POSTFIX = ## SS_INTERVAL_INSTALL_REDIS = [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_INSTALL_UBUNTU_BASH = [daily|half-weekly|weekly|half-monthly|monthly] ## ## SS_INTERVAL_INSTALL_UBUNTU_CRONTAB = [daily|half-weekly|weekly|half-monthly|monthly] ## ## SS_INTERVAL_INSTALL_UBUNTU_KERNEL = [weekly|half-monthly|monthly] ## ## SS_INTERVAL_INSTALL_UBUNTU_SSH = [weekly|half-monthly|monthly] ## ## SS_INTERVAL_INSTALL_UBUNTU_USERS = [weekly|half-monthly|monthly] ## ## SS_INTERVAL_INSTALL_UBUNTU_UTILS = ## SS_INTERVAL_INSTALL_WORDPRESS_CONFIG = [quarter-daily|half-daily|daily|half-weekly|weekly|half-monthly|monthly] ## ## SS_INTERVAL_INSTALL_WORDPRESS_CORE = [weekly|half-monthly|monthly|sometimes] ## ## SS_INTERVAL_INSTALL_WORDPRESS_MU_PLUGINS = [quarter-daily|half-daily|daily|half-weekly] ## SS_INTERVAL_INSTALL_ADMINER="never" SS_INTERVAL_INSTALL_CLAMAV="never" SS_INTERVAL_INSTALL_MYSQL="never" SS_INTERVAL_INSTALL_NGINX="never" SS_INTERVAL_INSTALL_PHP="never" # SS_INTERVAL_INSTALL_POSTFIX="never" SS_INTERVAL_INSTALL_REDIS="never" SS_INTERVAL_INSTALL_UBUNTU_BASH="half-weekly" SS_INTERVAL_INSTALL_UBUNTU_CRONTAB="half-monthly" SS_INTERVAL_INSTALL_UBUNTU_KERNEL="never" SS_INTERVAL_INSTALL_UBUNTU_SSH="never" SS_INTERVAL_INSTALL_UBUNTU_USERS="never" # SS_INTERVAL_INSTALL_UBUNTU_UTILS="never" # SS_INTERVAL_INSTALL_UFW="half-monthly" # SS_INTERVAL_INSTALL_WORDPRESS_CLI="never" SS_INTERVAL_INSTALL_WORDPRESS_CONFIG="weekly" SS_INTERVAL_INSTALL_WORDPRESS_CORE="sometimes" SS_INTERVAL_INSTALL_WORDPRESS_MU_PLUGINS="daily" #################################################################################################### #### SS-Config: Custom Cron Jobs (Added To SS Core Cron Job Schedules) ############################# #################################################################################################### ## MODULE VERSION: Ubuntu 20.04 LTS ## these are sourced directly by ss core cron jobs and will run on hardcoded schedules ## ## use normal bash (.e.g. php /var/www/html/script.php) and not crontab syntax ## SS_CUSTOM_CRON_OFTEN="" SS_CUSTOM_CRON_REGULAR="" SS_CUSTOM_CRON_QUARTER_HOURLY="" SS_CUSTOM_CRON_HALF_HOURLY="" SS_CUSTOM_CRON_HOURLY="" SS_CUSTOM_CRON_QUARTER_DAILY="" SS_CUSTOM_CRON_HALF_DAILY="" SS_CUSTOM_CRON_DAILY="" SS_CUSTOM_CRON_HALF_WEEKLY="" SS_CUSTOM_CRON_WEEKLY="" SS_CUSTOM_CRON_HALF_MONTHLY="" SS_CUSTOM_CRON_MONTHLY="" SS_CUSTOM_CRON_SOMETIMES="" #################################################################################################### #### SS-Config: MU (Must-Use) WordPress Plugins (Custom List) ###################################### #################################################################################################### ## MODULE VERSION: WordPress 5.5.x ## activate this custom list of MU (Must-Use) plugins using the SS_MU_PLUGINS variable ## ## NOTE: Autoloader, Custom Functions, Object Cache, and XXX Notices are required ## MU_PLUGIN_01_SOURCE="http://mirrors.slickstack.io/mu-plugins/clear-caches.zip" MU_PLUGIN_01_DIR="clear-caches" MU_PLUGIN_02_SOURCE="http://mirrors.slickstack.io/mu-plugins/cloudflare.zip" MU_PLUGIN_02_DIR="cloudflare" MU_PLUGIN_03_SOURCE="http://mirrors.slickstack.io/mu-plugins/dashboard-cleanup.zip" MU_PLUGIN_03_DIR="dashboard-cleanup" MU_PLUGIN_04_SOURCE="http://mirrors.slickstack.io/mu-plugins/delete-expired-transients.zip" MU_PLUGIN_04_DIR="delete-expired-transients" MU_PLUGIN_05_SOURCE="http://mirrors.slickstack.io/mu-plugins/disable-attachment-pages.zip" MU_PLUGIN_05_DIR="disable-attachment-pages" MU_PLUGIN_06_SOURCE="http://mirrors.slickstack.io/mu-plugins/disable-embeds.zip" MU_PLUGIN_06_DIR="disable-embeds" MU_PLUGIN_07_SOURCE="http://mirrors.slickstack.io/mu-plugins/disable-emojis.zip" MU_PLUGIN_07_DIR="disable-emojis" MU_PLUGIN_08_SOURCE="http://mirrors.slickstack.io/mu-plugins/disable-empty-trash.zip" MU_PLUGIN_08_DIR="disable-empty-trash" MU_PLUGIN_09_SOURCE="http://mirrors.slickstack.io/mu-plugins/disable-gutenberg.zip" MU_PLUGIN_09_DIR="disable-gutenberg" MU_PLUGIN_10_SOURCE="http://mirrors.slickstack.io/mu-plugins/disable-image-compression.zip" MU_PLUGIN_10_DIR="disable-image-compression" MU_PLUGIN_11_SOURCE="http://mirrors.slickstack.io/mu-plugins/disable-post-via-email.zip" MU_PLUGIN_11_DIR="disable-post-via-email" MU_PLUGIN_12_SOURCE="http://mirrors.slickstack.io/mu-plugins/disable-xml-rpc.zip" MU_PLUGIN_12_DIR="disable-xml-rpc" MU_PLUGIN_13_SOURCE="http://mirrors.slickstack.io/mu-plugins/error-log-monitor.zip" MU_PLUGIN_13_DIR="error-log-monitor" MU_PLUGIN_14_SOURCE="http://mirrors.slickstack.io/mu-plugins/force-https.zip" MU_PLUGIN_14_DIR="force-https" MU_PLUGIN_15_SOURCE="http://mirrors.slickstack.io/mu-plugins/force-strong-hashing.zip" MU_PLUGIN_15_DIR="force-strong-hashing" MU_PLUGIN_16_SOURCE="http://mirrors.slickstack.io/mu-plugins/header-cleanup.zip" MU_PLUGIN_16_DIR="header-cleanup" MU_PLUGIN_17_SOURCE="http://mirrors.slickstack.io/mu-plugins/limit-heartbeat.zip" MU_PLUGIN_17_DIR="limit-heartbeat" MU_PLUGIN_18_SOURCE="http://mirrors.slickstack.io/mu-plugins/maintenance-mode.zip" MU_PLUGIN_18_DIR="maintenance-mode" MU_PLUGIN_19_SOURCE="http://mirrors.slickstack.io/mu-plugins/minify-html.zip" MU_PLUGIN_19_DIR="minify-html" MU_PLUGIN_20_SOURCE="http://mirrors.slickstack.io/mu-plugins/plugin-blacklist.zip" MU_PLUGIN_20_DIR="plugin-blacklist" MU_PLUGIN_21_SOURCE="http://mirrors.slickstack.io/mu-plugins/server-status.zip" MU_PLUGIN_21_DIR="server-status" MU_PLUGIN_22_SOURCE="http://mirrors.slickstack.io/mu-plugins/sftp-details.zip" MU_PLUGIN_22_DIR="sftp-details" MU_PLUGIN_23_SOURCE="http://mirrors.slickstack.io/mu-plugins/virtual-robotstxt.zip" MU_PLUGIN_23_DIR="virtual-robotstxt" #################################################################################################### #### SS-Config: Included WordPress Plugins (Not MU Plugins) ######################################## #################################################################################################### ## MODULE VERSION: WordPress 5.5.x ## these plugins will be added to your WP website whenever ss-install or ss-update runs ## ## the activation status of these plugins will not be effected or modified (ever) ## # PLUGIN_01_SOURCE="http://mirrors.slickstack.io/mu-plugins/clear-caches.zip" # PLUGIN_01_DIR="clear-caches" # PLUGIN_02_SOURCE="http://mirrors.slickstack.io/mu-plugins/cloudflare.zip" # PLUGIN_02_DIR="cloudflare" #################################################################################################### #### Included Themes + Default Active Theme ######################################################## #################################################################################################### ## MODULE VERSION: WordPress 5.5.x ## these themes will be installed after Throwaway Theme setup completes (and is deleted) ## ## all default WordPress Core themes will be deleted (only below themes installed) ## # THEME_01_SOURCE="" # THEME_01_DIR="" #################################################################################################### #### Superuser (MU Plugin): Various Settings ####################################################### #################################################################################################### ## MODULE VERSION: WordPress 5.5.x # SUPERUSER_LOGIN # SUPERUSER_PASSWORD # SUPERUSER_EMAIL # SUPERUSER_NICENAME #################################################################################################### #### Email API Settings (SendGrid, Mailgun, Etc) ################################################### #################################################################################################### # MAIL_API_KEY="123456789" ### MAIL_SERVICE="sendgrid" # MAIL_SMTP_SERVER="smtp.sendgrid.net" # MAIL_PORT="587" # mailalert="user@example.com" # MAIL_USER="example" # MAIL_PASSWORD="password" ## EOF ##