Laravel+Svelte
This example assumes you have already created your own Territory. If you have not, please refer to this guide.
In this tutorial we will be deploying our example application to CitadelHosts. We will upload the images that define our application to our Smart Image Registry. Then we will define our custom application in CitadelHosts. Finally, we will deploy that application to our own Territory instance.
Our Example Application
This Laravel example application features a simple TODO app built with the Laravel Installer. It has a Svelte frontend. The application uses a SQlite database for simplicity.
The application is available on GitHub at: https://github.com/LiamJFitzpatrick/citadel-laravel-example.
Uploading Custom Images To Your Smart Registry
The example application contains a Dockerfile to define the application and it's environment. For our example, we have walkthroughs for deploying using GitHub Actions to build and upload your image or you can follow along the guide to build and deploy your image from your local machine using Docker.
Using GitHub Actions
An example deploy workflow is provided below. This will build the necessary images and upload them to your CitadelHosts account. You can clone the example repository and then push the code to your own GitHub repository. Whenever changes are pushed to your GitHub repository they will be automatically sent to your CitadelHosts registry. This is great to be able to enable automatic deployments.
.github/workflows/deploy.yml
name: Build and Push Container Image
on:
push:
branches:
- develop
- main
- master
tags:
- 'v*'
env:
REGISTRY: registry.citadelhosts.com
IMAGE_NAME: ${{ secrets.IMAGE_NAME }}
jobs:
build-and-push:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to private registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
- name: Extract metadata
id: meta
uses: docker/metadata-action@v5
with:
# Combines registry and image name into a clean string
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=sha
- name: Build and push
uses: docker/build-push-action@v6
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
This deploy workflow requires the following secrets in your repository:
- IMAGE_NAME: This is the name that the Laravel application image will have in your CitadelHosts registry.
- REGISTRY_USERNAME: This is your CitadelHosts username.
- REGISTRY_PASSWORD: This is your CitadelHosts password.
Using Docker CLI
Getting and Building The Application
After you have cloned the repository, navigate into the newly created folder.
git clone https://github.com/LiamJFitzpatrick/citadel-laravel-example.git
cd citadel-laravel-example
Build the Laravel application image.
docker build -t registry.citadelhosts.com/laravel-example:latest -f Dockerfile ./
Authenticate your Docker CLI with the CitadelHosts.com Smart Image Registry. You will login using the same credentials you use to login to CitadelHosts.com.
docker login registry.citadelhosts.com
Push your newly built images to your registry.
docker push registry.citadelhosts.com/laravel-example:latest
Congrats! You have successfully uploaded the example application to your CitadelHosts account!
Defining Custom Applications
To define a custom application navigate to the Apps page and scroll down to the Create Application section (or click this link: https://citadelhosts.com/dashboard/apps#create-application).
This form allows you to define custom application configurations.
Step 1: Application Definition
The first step is to define the application. The table below shows suggested input values for our example.
| Label | Value | Description |
|---|---|---|
| Name | Laravel Example | This is the name of your application and will appear in your App Library |
| Description | An simple TODO application built with Laravel. | A description for your custom application. |
Step 2: Container Definition
The second step is to define the containers that will make up our application. Our example application consists of 1 container, so you can hit Add Container for 1 container. The suggested inputs are summarized in the tables below.
Container 1 Definition: Laravel Application
| Label | Value |
|---|---|
| Name: | todoapp |
| Start Order: | 0 |
| Image: | citadel-laravel-example:latest |
Step 3: Container Configuration
The final step in defining your custom application is going to be to configure ports, volumes, and environment variables for each of the containers that make up your application. The necessary configuration for our example application is summarized in the sections below.
backend Configuration
| Ports | |
|---|---|
| Container Port: | 80 |
Environment Variables:
| Key | Value |
|---|---|
| APP_ENV | production |
| APP_DEBUG | false |
Finishing Up
Now that you have defined your application in the form, you just need to hit Create. You have succesfully defined your own custom Laravel application on CitadelHosts! This application is available just to your account and can be deployed to any Territory of your choosing.
Deploying Custom Applications
Deploying custom applications is just as easy as deploying pre-configured applications. All one has to do is select the Territory you would like to deploy the application on and hit Deploy! Start the app up and navigate to your access link to view your own custom application. Great work!