Welcome to ubuntu-server-setup’s documentation

Note

ubuntu-server-setup is an opinionated bash setup script to automate the setup and provisioning of Ubuntu servers, primarily biased towards python web applications (Django, Flask, etc.).

Why this documentation?

This documentation was written to provide additional context and rationale behind the engineervix/ubuntu-server-setup project, which was forked from jasonheecs/ubuntu-server-setup.

It is hoped that this will provide a useful reference not only for those who seek to use the setup script to bootstrap their Ubuntu server, but also for those that would like to fork the project and adapt it to their specific needs, just as I did.

Perhaps you like the project and would like to contribute to its improvement – this documentation will hopefully help you get a better understanding of what’s going on “under the hood”.

Notwithstanding, I also wrote this documentation for my future self, because many times I forget the very code that I wrote, and even wonder why and how I wrote it!

Contents

• 1. Introduction
• 2. Project Features
  • 2.1. Terminal Enhancements
  • 2.2. Git Customization
  • 2.3. Node.js Stack
  • 2.4. Python Stack
  • 2.5. Ruby
  • 2.6. Database Stack
  • 2.7. Webserver
  • 2.8. Certbot
  • 2.9. Text Editor
  • 2.10. Mail
  • 2.11. System Administration
  • 2.12. Additional Server Hardening
  • 2.13. Additional Packages
  • 2.14. Miscellaneous Tasks
• 3. Project Structure
  • 3.1. Directories
  • 3.2. Files
• 4. Functions
• 5. Roadmap
• 6. Contributing
  • 6.1. Before making a pull request