cms-deploy

How to deploy LumeCMS in a VPS

1. Enable the authentication and git in the CMS:

   // user and pass are environment variables, stored in an .env file
   const user = Deno.env.get("CMS_USER") ?? "admin";
   const pass = Deno.env.get("CMS_PASSWORD") ?? "";
   
   cms.auth({
     [user]: pass,
   });
   
   // Enable git to pull/push changes
   cms.git();
   

2. In your deno.json file create the following task:

   {
     "tasks": {
       // ...
       "cms:prod": "deno serve -A --env-file https://deno.land/x/lume_cms_adapter@v0.2.2/mod.ts"
     }
   }
   

   You can run deno task cms:prod in your computer to check if it works fine. The CMS should ask you for the user/pass and you should see a “Sync” button in the CMS to push/pull changes to the git repository.

3. Get a VPS from Hetzner, Digital Ocean, or similar service.
   • This script was tested only on Ubuntu 24.04.
4. Create an A record in the DNS settings of your domain to the server IP. For example, cms.example.com.
5. Log in from SSH and run:

   curl https://lumeland.github.io/cms-deploy/install.sh > install.sh && sh install.sh
   

6. After updating and installing some packages, the script will ask you for some info:
   • The SSH URL of the repository. Example: git@github.com:user/repo.git.
   • An email. It’s used for git commits, or to create the SSL certificate.
   • The domain for the CMS: cms.example.com.
   • When generating the public/private rsa key pair, leave the passphrase empty.
   • During the process, it will ask you to add a deploy key.
     • Go to the GitHub respository / Settings / Deploy keys / Add deploy key.
     • Paste the key printed in the terminal.
     • Make sure to check “Allow write access”.
     • Once the key is added, press Enter in the terminal to continue.
7. When the script is finished you should see your site and be able to edit the pages.