From f9efdc88ee1410e860c8efbff05f8758ab6af408 Mon Sep 17 00:00:00 2001 From: Greg Date: Sun, 25 May 2025 15:32:50 +0200 Subject: [PATCH] first commit --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5c3193c --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Hugo Site for Coolify Deployment + +This is a basic Hugo static site, ready to be deployed on Coolify using Nixpacks. + +## Prerequisites + +1. A Coolify instance (self-hosted or cloud). +2. This Git repository connected to your Coolify instance. +3. Hugo installed locally if you want to develop and test the site before pushing changes (optional but recommended). You can download Hugo from [gohugo.io](https://gohugo.io/). + +## Deployment Steps on Coolify + +1. **Add a New Resource:** In your Coolify dashboard, go to your project and add a new resource. +2. **Select Source:** Choose "Git Repository". +3. **Configure Git:** + * Select your Git provider and repository. + * Choose the branch you want to deploy (e.g., `main` or `master`). +4. **Build Configuration:** + * **Build Pack:** Select `Nixpacks`. + * **Type:** Choose `Static Site`. +5. **Settings:** + * **Build Command:** `hugo` + * **Publish Directory:** `public` + * (Coolify might auto-detect these for Hugo with Nixpacks, but it's good to confirm.) +6. **Save and Deploy:** Save your configuration and trigger a deployment. + +Coolify will then use Nixpacks to build your Hugo site (by running the `hugo` command) and serve it from the `public` directory. + +## Local Development (Optional) + +1. Clone this repository. +2. Install Hugo (if not already installed). +3. Navigate to the project directory in your terminal. +4. Run `hugo server -D` to start the local development server. +5. Open your browser to `http://localhost:1313` (or the port shown in the terminal). + +## Project Structure + +* `hugo.toml`: Main Hugo configuration. +* `content/`: Your site's content (Markdown files). +* `layouts/`: Your site's templates (HTML files). (Create this if you want to customize the theme or create your own). +* `static/`: Static assets like images, CSS, JS. (Create this for your assets). +* `themes/`: Where Hugo themes are typically placed. (Create this if you add a theme). +* `public/`: The output directory where Hugo builds the static site. This directory is usually not committed to Git. Coolify will generate it during the build process. + +Remember to add a theme to your `hugo.toml` and place it in the `themes` folder, or build your own layouts in the `layouts` folder to see more than just plain HTML.