5min Speed Run Deploy

This is a simple setup and deploy scripts to run a server with Nginx, Node and SSL enabled.

Must-Haves

1. Have your code in a GitHub repository
2. Have a server running somewhere (I use Digital Ocean)
3. Have a domain with A record pointing to your server IP

Getting Started

1. Copy the script to your box using:

scp box/speed_run_deploy.sh root@server_ip:~/speed_run_deploy.sh

2. Log into your server

ssh root@server_ip

Obs: Assuming you're logging in as root, the script will create a deployer user.

3. Run the script and follow the instructions!

bash speed_run_deploy.sh

It will install Nginx, PM2, Node.js, setup SSL and Firewall for you.

After Setup...

4. Exit the box
5. (From your machine) Copy the public key (it was created in ~/.ssh/deployer.pub in your machine):

cat ~/.ssh/deployer.pub | pbcopy

6. Go to https://github.com/settings/keys
7. Click 'Add new SSH' Key and paste the contents in public key field
8. Copy the private key contents (it was created in ~/.ssh/deployer in your machine):

cat ~/.ssh/deployer | pbcopy

9. Push your code to Github

10. Copy the repository URL

11. Go to https://github.com/<YOUR GITHUB USER>/<YOUR REPO NAME>/settings/secrets/actions

12. Create secret SSH_PRIVATE_KEY and paste the private key contents

13. Create secret: SERVER_IP as

14. Create secret: SERVER_USER as

15. SSH into your server using the deployer user:

ssh -i ~/.ssh/deployer deployer@<YOUR SERVER IP>

16. Clone your repository into /var/www/<DOMAIN NAME>

git clone https://github.com/<YOUR GITHUB USER>/<YOUR REPO NAME>.git /var/www/<DOMAIN NAME>

Done! Every merge to main branch will be deployed.

Try it out!

17. Commit something to the main branch (or the one you selected in setup)
18. The action will run automatically, wait until it finishes
19. Access your domain and there you have it!

Boilerplate

Use the template for a Next.js application...

This is a Next.js project bootstrapped with create-next-app. You may use the boilerplate as is, it works!

...or use it for another stack!

You just need the following files if you want just the deploy script:

.github/actions/deploy.yaml
.github/workflows/deploy-prod.yaml
box/speed_run_deploy.sh

You will also need to edit speed_run_deploy.sh because it creates a deploy.sh script that you may want to edit.

Cheers,

Thiago V Ricieri

• System Thinker @ Systematic Success
• Maker @ Making of a Maker
• Engineering Manager,  Apps @ Pluto TV / Paramount Global
• Founder @ Ghost Ship & Co.
• Digital Nomad @ Threads, X.com, LinkedIn, GitHub, Instagram, Website