Superdesk Auto-Installer Script

This script is designed to automate the initial deployment of a production ready setup of Superdesk and its related components using Docker and bash scripting.

This is a free-to-use Bash script that allows you to easily install Superdesk and enhance its security with a single command. You can utilize this script on a blank server or an existing server, making it suitable for both new and experienced Superdesk server owners.

The script handles the entire Superdesk installation process, including activating the admin user. It ensures the security of your Superdesk server by changing the SSH port, installing a firewall, and automatically updating the firewall rules to reflect the new SSH port and installing Fail2Ban with progressive blocking rules.

The Bash file is unencrypted, freely usable, and redistributable (though credit to Honeytree Technologies is required).

About Superdesk

Superdesk is an open source end-to-end news creation, production, curation, distribution and publishing platform developed and maintained by Sourcefabric with the sole purpose of making the best possible software for journalism. It is scaleable to suit news organizations of any size.

About the Script

• Language: Bash
• Deployment: Uses Docker images for deploying Superdesk containers.
• Configuration:
  • SSL certificate generation via Let's Encrypt for designated domains and Nginx setup.

Pre-requisites

• Server or VPS with a minimum of 4GB Ram, 2 vCPU, and 65 GB storage.
• Ubuntu v20.04 LTS pre-installed.
• Open ports: 443, 80 and SSH (Which you will choose in the script).
• Machine should have internet access for fetching packages and Docker images.
• Pre-register the machine's IP with the domain for SSL certificate generation.
• An email delivery service or SMTP server.

Deployment Steps

1. SSH into the machine and assume root privileges.

2. Create and navigate to a directory: mkdir auto_script && cd auto_script. You can also use own directory.

3. Run the following command to start the script.

   curl -lO https://code.honeytreetech.com/cms/superdesk/auto-installer/superdesk_auto_script.sh && sudo chmod +x superdesk_auto_script.sh && ./superdesk_auto_script.sh

4. Input the requested details as per the following table.

   Name	Description	Mandatory	Optional	Default Value
   admin_user	Admin username	✓	✖	✖
   admin_email	Admin email	✓	✖	✖
   admin_password	Admin password	✓	✖	✖
   application_name	Application name	✓	✖	✖
   domain_name	Domain name	✓	✖	✖
   smtp_server	SMTP server	✓	✖	✖
   smtp_port	SMTP port	✓	✖	✖
   smtp_from_address	SMTP from address	✓	✖	✖
   smtp_username	SMTP user name	✓	✖	✖
   smtp_password	SMTP password	✓	✖	✖
   port	SSH port	✓	✖	✖

5. Accept terms of service as prompted.

6. Create Admin user and password during installation of script.

7. Follow further on-screen instructions to complete the setup.

Post Deployment

• Access Superdesk via the provided domain with the given admin credentials.
• SSH port defaults to new port (which you entered in the script).
• fail2ban is activated with progressive blocking.

Post-Installation Security Recommendations

Once you have successfully deployed Superdesk using this script, it's crucial to take additional steps to secure and harden your environment.

Consider the following actions:

• Regular Updates: Ensure that all system packages and software are regularly updated to patch potential vulnerabilities.
• Firewall Configuration: Fine-tune your firewall settings to allow only necessary traffic and block potential threats.
• User Access: Limit or disable root access. Use sudo for administrative tasks and avoid using the root account for daily tasks.
• Secure Passwords: Implement strong password policies, and consider using password managers.
• Two-Factor Authentication: Where possible, enable 2FA for critical services and accounts.
• Backup: Regularly back up critical data and ensure backups are stored securely.
• Monitoring & Logging: Set up monitoring and logging to detect and alert on suspicious activities.
• Application-Specific Security: Explore and implement security best practices specifically tailored to Superdesk and any other applications you might be running.
• Review and Audit: Periodically review and audit your security settings and practices to ensure they are up-to-date with the latest threats and vulnerabilities.

It's essential to recognize that the security landscape is dynamic. Stay informed, and be proactive in securing your digital assets.

Disclaimer

Using the installer is solely at your own risk, and you are responsible for any issues regarding quality, performance, accuracy, and effort. Additionally, support is only available to managed services clients of Honeytree Technologies, LLC; no free support is provided.

CREDITS

This script and deployment guide have been made possible by Honeytree Technologies, LLC.

Please follow @jeff@honeytree.social.