+
+
+
+ Docs
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/components/content/MarketingHeader.vue b/docs/components/content/MarketingHeader.vue
index 64d81b9b..934c6832 100644
--- a/docs/components/content/MarketingHeader.vue
+++ b/docs/components/content/MarketingHeader.vue
@@ -66,6 +66,18 @@
Docs
+
+
+
+
+ Spin Hub
+
+ A place to share and build templates together.
+
+
+
+
+
+ ![]()
+
+
+
+
+
+ {{ template.category }}
+
+
+ {{ template.title }}
+{{ template.description }}
+
+ ![]()
+
+
+
+ {{ template.author }}
+
+
+
+
+ Hub
diff --git a/docs/content/docs/1.installation/1.install-macos.md b/docs/content/docs/1.installation/1.install-macos.md index 11785964..806a843a 100644 --- a/docs/content/docs/1.installation/1.install-macos.md +++ b/docs/content/docs/1.installation/1.install-macos.md @@ -3,7 +3,14 @@ head.title: 'Install to macOS - Spin by Server Side Up' title: 'Install to macOS' description: 'Learn how to install Spin on macOS. No root access required.' layout: docs +canonical: https://serversideup.net/open-source/spin/docs/installation/install-macos --- + +# Install to macOS +::lead-p +Spin easily runs on any macOS machine that runs Docker Desktop. Getting started is as simple as installing Docker Desktop, then running a single command to install `spin`. +:: + ## Install Docker Desktop MacOS does not ship with Docker by default. To get Docker installed, you will need "Docker Desktop", which is the official desktop tool developed by Docker. diff --git a/docs/content/docs/1.installation/2.install-windows.md b/docs/content/docs/1.installation/2.install-windows.md index 6d4761ec..4ebbe512 100644 --- a/docs/content/docs/1.installation/2.install-windows.md +++ b/docs/content/docs/1.installation/2.install-windows.md @@ -3,6 +3,7 @@ head.title: 'Install to Windows - Spin by Server Side Up' title: 'Install to Windows' description: 'Learn how to install Spin on Windows using the Linux Subsystem.' layout: docs +canonical: https://serversideup.net/open-source/spin/docs/installation/install-windows --- # Install to Windows diff --git a/docs/content/docs/1.installation/3.install-linux.md b/docs/content/docs/1.installation/3.install-linux.md index d3ed4cbb..54074dcd 100644 --- a/docs/content/docs/1.installation/3.install-linux.md +++ b/docs/content/docs/1.installation/3.install-linux.md @@ -3,8 +3,14 @@ head.title: 'Install to Linux - Spin by Server Side Up' title: 'Install to Linux' description: 'Learn how to install Spin on Linux.' layout: docs +canonical: https://serversideup.net/open-source/spin/docs/installation/install-linux --- +# Install to Linux +::lead-p +Spin is able to run on any Linux machine that supports Docker. Getting started is as simple as installing Docker, then running a single command to install `spin`. +:: + ## Prerequisites You must have a working installation of Docker. diff --git a/docs/content/docs/1.installation/4.install-composer.md b/docs/content/docs/1.installation/4.install-composer.md index 4bbaa451..29db57df 100644 --- a/docs/content/docs/1.installation/4.install-composer.md +++ b/docs/content/docs/1.installation/4.install-composer.md @@ -3,11 +3,17 @@ head.title: 'Install via Composer - Spin by Server Side Up' title: 'Install via Composer' description: 'Spin can be installed using Composer, a popular PHP package manager. This enables you to make Spin accessible without other developers doing any steps on their end.' layout: docs +canonical: https://serversideup.net/open-source/spin/docs/installation/install-composer --- -Installing `spin` at the project level is a great way to deploy `spin` without much configuration from the user's end. [View `spin` on Packagist →](https://packagist.org/packages/serversideup/spin) +# Install via Composer +::lead-p +Spin can be installed using Composer, a popular PHP package manager. This enables you to make Spin accessible without other developers doing any steps on their end. +:: ## Add `spin` to your project with Composer +Installing `spin` at the project level is a great way to deploy `spin` without much configuration from the user's end. [View `spin` on Packagist →](https://packagist.org/packages/serversideup/spin) + We can use Docker to run `composer` and install it on your project. **Run this command from the parent folder of your project.** ::code-panel diff --git a/docs/content/docs/1.installation/5.install-npm-yarn.md b/docs/content/docs/1.installation/5.install-npm-yarn.md index f47877ed..0e248cf8 100644 --- a/docs/content/docs/1.installation/5.install-npm-yarn.md +++ b/docs/content/docs/1.installation/5.install-npm-yarn.md @@ -3,11 +3,17 @@ head.title: 'Install via NPM/Yarn - Spin by Server Side Up' title: 'Install via NPM/Yarn' description: 'Spin can be installed using NPM or Yarn, two popular JavaScript package managers. This enables you to make Spin accessible without other developers doing any steps on their end.' layout: docs +canonical: https://serversideup.net/open-source/spin/docs/installation/install-npm-yarn --- -Installing `spin` at the project level is a great way to deploy `spin` without much configuration from the user's end. [View `spin` on NPM →](https://www.npmjs.com/package/@serversideup/spin) +# Install via NPM/Yarn +::lead-p +Spin can be installed using NPM or Yarn, two popular JavaScript package managers. This enables you to make Spin accessible without other developers doing any steps on their end. +:: ## Add `spin` to your project with Yarn/NPM +Installing `spin` at the project level is a great way to deploy `spin` without much configuration from the user's end. [View `spin` on NPM →](https://www.npmjs.com/package/@serversideup/spin) + We can use Docker to run install `spin` on your project. **Run this command from the parent folder of your project.** ::note diff --git a/docs/content/docs/11.community/1.get-help.md b/docs/content/docs/11.community/1.get-help.md new file mode 100644 index 00000000..9c5dfa5d --- /dev/null +++ b/docs/content/docs/11.community/1.get-help.md @@ -0,0 +1,61 @@ +--- +head.title: 'Get Help - Spin by Server Side Up' +title: 'Get Help' +description: 'Learn how to get help with Spin.' +layout: docs +--- + +# Get Help +::lead-p +We're huge believers the product is only as good as the community that supports it. We're here to help you get the most out of Spin. +:: + +## Ensure you're on the latest version +We're always shipping new features and bug fixes for Spin. Ensure you're on the latest release by checking the [releases page](https://github.com/serversideup/spin/releases). + +You can also run `spin update` to ensure you're on the latest version. + +If you're still having issues, sometimes deleting Spin and reinstalling might be a quick fix because it's so easy to delete and reinstall. + +## Debugging +If you think you've found a bug in Spin, you can get debug logs by setting the `SPIN_DEBUG` environment variable to `true` before running any commands. + +::code-panel +--- +label: Set SPIN_DEBUG to true +--- +```bash +SPIN_DEBUG=true spin version +``` +:: + +This will show you exactly what Spin is running and these debug logs can help the community help you faster. + +## Going back to the stable release +Going back to the stable release is as easy as deleting the `~/.spin` directory then following the installation instructions to reinstall Spin. + +::code-panel +--- +label: Delete Spin and reinstall +--- +```bash +rm -rf ~/.spin +``` +:: + +Now follow the installation instructions for your operating system: + +- [Install to macOS](/docs/installation/install-macos) +- [Install to Linux](/docs/installation/install-linux) +- [Install to Windows](/docs/installation/install-windows) + +## Community Support +If you're still having issues, our community primarily uses [GitHub Discussions](https://github.com/serversideup/spin/discussions) and [Discord](https://serversideup.net/discord) to get help with Spin. + +## Resources +We offer a number of resources to help you get the most out of Spin: +- **[Website](https://serversideup.net/open-source/spin)** overview of the product. +- **[Docs](https://serversideup.net/open-source/spin/docs)** for a deep-dive on how to use the product. +- **[Discord](https://serversideup.net/discord)** for friendly support from the community and the team. +- **[GitHub Repo](https://github.com/serversideup/spin)** for source code, bug reports, and project management. +- **[Get Professional Help](https://serversideup.net/professional-support)** - If you need video + screen-sharing support, we offer that too. diff --git a/docs/content/docs/11.community/2.testing.md b/docs/content/docs/11.community/2.testing.md new file mode 100644 index 00000000..cf528712 --- /dev/null +++ b/docs/content/docs/11.community/2.testing.md @@ -0,0 +1,61 @@ +--- +head.title: 'Testing New Releases - Spin by Server Side Up' +title: 'Testing New Releases' +description: 'Learn how to test new releases of Spin.' +layout: docs +--- + +# Testing New Releases +::lead-p +Spin is a collection of many open source projects built by the Server Side Up community. If you're looking for the latest features, here is how you can help test them out. +:: + +## Installing latest Spin beta release +Spin is very lightweight and is installed to your `~/.spin` directory by default. If you'd like to install the latest beta, we can easily + +::code-panel +--- +label: Install latest Spin beta release +--- +```bash +# Ensure previous installation is removed +rm -rf ~/.spin + +# Install the latest release (regardless of pre-release or stable) +bash -c "$(curl -fsSL https://raw.githubusercontent.com/serversideup/spin/main/tools/install.sh)" "" --beta +``` +:: + +## Going back to the stable release +Going back to the stable release is as easy as deleting the `~/.spin` directory then following the installation instructions to reinstall Spin. + +::code-panel +--- +label: Delete the ~/.spin directory +--- +```bash +rm -rf ~/.spin +``` +:: + +Now follow the installation instructions for your operating system: + +- [Install to macOS](/docs/installation/install-macos) +- [Install to Linux](/docs/installation/install-linux) +- [Install to Windows](/docs/installation/install-windows) + +## Repositories +There are many repositories that are part of the Spin project. Refer to each repository for instructions on how to test the latest changes. + +#### Ansible Collection +- [Spin Ansible Collection](https://github.com/serversideup/ansible-collection-spin) - Used to provision and maintain your production server. + +#### GitHub Actions +- [serversideup/docker-build-action](https://github.com/marketplace/actions/docker-build-action) - A simplified syntax to build and publish your Docker images with GitHub Actions. +- [serversideup/docker-swarm-deploy-github-action](https://github.com/marketplace/actions/docker-swarm-deploy-github-action) - A simplified syntax to deploy to Docker Swarm Mode via GitHub Actions. + +#### Docker Images +- [serversideup/php](https://serversideup.net/open-source/docker-php/) - PHP Docker images highly optimized to work with Laravel + Spin. +- [serversideup/docker-ssh](https://github.com/serversideup/docker-ssh) - A lightweight docker image that runs SSH. This is a fantastic method on using a secure SSH tunnel into your database cluster. +- [serversideup/docker-ansible](https://github.com/serversideup/docker-ansible) - A lightweight docker image that runs Ansible. This allows users to provision their server without needing to know how to install or maintain their Ansible installation. +- [serversideup/docker-github-cli](https://github.com/serversideup/docker-github-cli) - A lightweight docker image that runs GitHub CLI. This allows users to interact with GitHub without needing to install the GitHub CLI on their machine. \ No newline at end of file diff --git a/docs/content/docs/6.community/3.contributing.md b/docs/content/docs/11.community/3.contributing.md similarity index 100% rename from docs/content/docs/6.community/3.contributing.md rename to docs/content/docs/11.community/3.contributing.md diff --git a/docs/content/docs/2.getting-started/1.how-spin-works.md b/docs/content/docs/2.getting-started/1.how-spin-works.md index 839c17ab..1d659ed9 100644 --- a/docs/content/docs/2.getting-started/1.how-spin-works.md +++ b/docs/content/docs/2.getting-started/1.how-spin-works.md @@ -3,6 +3,7 @@ head.title: 'How Spin Works - Spin by Server Side Up' title: 'How Spin Works' description: 'Learn what Spin is and how it works.' layout: docs +canonical: https://serversideup.net/open-source/spin/docs/getting-started/how-spin-works --- # How Spin Works @@ -10,6 +11,9 @@ layout: docs Spin is a collection of proven open source technologies delivered to you in a lightweight and simple experience. This document explains what technologies Spin uses, how it works, and how this tool can enable you to have a lot of power and freedom to self-host and distribute your applications. :: +## Spin stays out of your way +Spin is designed to be flexible and gives you the power to choose what you'd like Spin to help you with. For example, if you want to use your current PaaS provider for production deployments, but you just want to use Spin for local development, you can easily do that without Spin getting in the way. Simply delete the `docker-compose.prod.yml` file and you won't need to do anything else. + ## What Spin Is Built On Top Of  @@ -18,8 +22,8 @@ At the core of Spin are: - [Docker Swarm Mode](https://docs.docker.com/engine/swarm/) (used in production, staging, etc.) - [Ansible](https://www.ansible.com/) (used to ensure your server is configured correctly) -### Templates -We offer templates to help you get started with Spin, or you can [create your own template](/docs/project-templates/create-your-own-template). +### Templates on Spin Hub +We have organized a [community hub](/hub) where you can find templates created by the Spin team and the community. You can also [create your own template](/docs/advanced/create-your-own-template). ### Flexible deployments With Spin, you have two options for deployments: @@ -39,6 +43,8 @@ Spin accesses and utilizes other open source projects to simplify your developme #### Docker Images - [serversideup/php](https://serversideup.net/open-source/docker-php/) - PHP Docker images highly optimized to work with Laravel + Spin. - [serversideup/docker-ssh](https://github.com/serversideup/docker-ssh) - A lightweight docker image that runs SSH. This is a fantastic method on using a secure SSH tunnel into your database cluster. +- [serversideup/docker-ansible](https://github.com/serversideup/docker-ansible) - A lightweight docker image that runs Ansible. This allows users to provision their server without needing to know how to install or maintain their Ansible installation. +- [serversideup/docker-github-cli](https://github.com/serversideup/docker-github-cli) - A lightweight docker image that runs GitHub CLI. This allows users to interact with GitHub without needing to install the GitHub CLI on their machine. ## Why not just use these technologies directly? Spin is designed to reduce the learning curve for delivering containerized applications with Docker. This is where we believe the 99% of people are. If you're looking to start a new project and deliver it quickly without breaking the bank, Spin is for you. Everything is designed to have your application disposable, repeatable, and scalable. @@ -52,13 +58,7 @@ Spin's flexibility comes from embracing the [Docker Compose Overrides (aka Docke Here is a visual of what the file structure looks like: -::responsive-image ---- -src: /images/docs/whats-spin/docker-compose-overrides.png -alt: 'Docker Compose Overrides' -maxWidth: 500 ---- -:: + Docker natively selecting these files, but it is a huge pain to type out each time. This is what we would have to type to bring our project up. diff --git a/docs/content/docs/2.getting-started/2.create-a-new-project-with-spin.md b/docs/content/docs/2.getting-started/2.create-a-new-project-with-spin.md new file mode 100644 index 00000000..40a14403 --- /dev/null +++ b/docs/content/docs/2.getting-started/2.create-a-new-project-with-spin.md @@ -0,0 +1,41 @@ +--- +head.title: 'Create a New Project with Spin - Spin by Server Side Up' +title: 'Create a New Project with Spin' +description: 'Learn how to create a new project with Spin.' +layout: docs +--- + +# Create a project with Spin +::lead-p +Getting up an running with Spin is very easy. It's recommended to install Spin globally so you can easily create new projects. Follow the installation instructions for [macOS](/docs/installation/install-macos/), [Linux](/docs/installation/install-linux), or [Windows](/docs/installation/install-windows) before continuing. We'll walk you through the process of creating a new Laravel project with Spin. +:: + +## Finding a project on "Spin Hub" +We created a [community hub](/hub) where you can find templates created by the Spin team and the community. We're in the early stages of development, but [anyone can create their own template](/docs/advanced/create-your-own-template) and we will publish it to Spin Hub for you. + +## Let's create a new Laravel project +For our example, we will use the "Laravel" template from Spin Hub. We have a command called `spin new`, which will take care of the heavy lifting for you + +::code-panel +--- +label: "Create a new Laravel project called \"my-billion-dollar-idea\"" +--- +```bash +spin new laravel my-billion-dollar-idea +``` +:: + +This will create a project in your current directory called `my-billion-dollar-idea`. You can also specify a path to create the project in a different directory. + +
+ +
+ +Assuming you completed the prerequisites, the onboard wizard will take you through the process so you can get a local development environment with `spin up`. + +## Starting the development environment +Next, we'll start the development environment with `spin up`. + +[Starting up your Development Environment →](/docs/development-environment/starting-up-your-development-environment) \ No newline at end of file diff --git a/docs/content/docs/2.getting-started/2.add-spin-to-an-existing-project.md b/docs/content/docs/2.getting-started/3.add-spin-to-an-existing-project.md similarity index 82% rename from docs/content/docs/2.getting-started/2.add-spin-to-an-existing-project.md rename to docs/content/docs/2.getting-started/3.add-spin-to-an-existing-project.md index 5971b4dc..4b4d5fd7 100644 --- a/docs/content/docs/2.getting-started/2.add-spin-to-an-existing-project.md +++ b/docs/content/docs/2.getting-started/3.add-spin-to-an-existing-project.md @@ -35,10 +35,11 @@ spin init- -
- -Assuming you completed the prerequisites, the onboard wizard will take you through the process so you can get a local development environment with `spin up`. - -## Further Configuration -::note -Since we're using the [Laravel Basic](/docs/project-templates/laravel-basic) template, it's important to review the [project's README file](https://github.com/serversideup/spin-template-laravel-basic) for any additional steps required after creating the project. -:: - -Regardless of what template you're using, it's always important to review the template's README file for any additional steps required after creating the project. You may need to customize project URLs, environment variables, or other settings to get your project up and running. - -Once you have things configured, it could be possible to stop here and just have Spin manage your development environment -- but you won't get the full benefit of Spin. - -Spin is designed to keep your infrastructure 100% the same, no matter the environment. In the remainder of this guide, we'll show you how to deploy your project to a server. - -## Choosing a deployment strategy -Spin offers two deployment strategies: - -1. [`spin deploy` ](/docs/command-reference/deploy) (simple) -1. [GitHub Actions](/docs/advanced/zero-downtime-deployments-with-github-actions) (advanced) - -| | spin deploy | GitHub Actions | -|-------------------------|----------------------|-------------------------| -| Difficulty | Very Easy | Complex (it's automated CI/CD after all 🤪) | -| Team Size | Small teams | Small to very large teams | -| Zero-downtime Deployments | ✅ | ✅ | -| Automated Testing | ❌ | ✅ (you have to configure this though) | - - -### `spin deploy` (simple) -If you're a small team or bootstrapping a project to get it out the door as fast as possible, `spin deploy` might be your best friend. - -Without the headache of CI/CD, `spin deploy` will perform a zero-downtime deployment from your local machine to your server directly over SSH. There are no requirements for having a CI/CD pipeline or private Docker registries. - -Read more about `spin deploy` in the [command reference](/docs/command-reference/deploy). - -### GitHub Actions (advanced) -For GitHub Actions, we created an entire guide on how to achieve zero-downtime deployments with GitHub Actions. This is a more advanced strategy, but it's worth it if you're looking to automate your deployments. - -[Learn more about GitHub Actions deployments →](/docs/advanced/zero-downtime-deployments-with-github-actions) - -## Deploying to a server -Although it is possible to just use Spin for local development only, you'll get the full benefit of Spin when you use it to deploy your application to a server. - -Use the guide below to learn how to get your servers ready for a Spin deployment: - -[Prepare Your Servers for Spin →](/docs/getting-started/preparing-your-servers-for-spin) \ No newline at end of file diff --git a/docs/content/docs/2.getting-started/3.preparing-your-servers-for-spin.md b/docs/content/docs/2.getting-started/3.preparing-your-servers-for-spin.md deleted file mode 100644 index 241542b0..00000000 --- a/docs/content/docs/2.getting-started/3.preparing-your-servers-for-spin.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -head.title: 'Preparing Your Servers For Spin - Spin by Server Side Up' -title: 'Preparing Your Servers For Spin' -description: 'Learn how to get your server ready for Spin deployment.' -layout: docs ---- - -# Preparing your server -::lead-p -Spin gives you the power to choose any host that you want. Although the responsibility is on your shoulders to get a server set up, Spin makes it very easy to get this accomplished. -:: - -## Choose a host -We've run [VPS Benchmarks against a number of hosts](https://521dimensions.notion.site/VPS-Benchmarks-for-Self-hosters-c6eca7c5f16d4bb8aeb989174fc58ffe?pvs=4) and have found the following hosts to have great value. The links below are referral links, meaning we get a small kickback if you sign up -- but this doesn't affect our recommendations. - -### Hetzner -Hetzner is a German-based company with data centers in the EU and the US. Their pricing is very competitive and they have incredible performance. - -With the link below, they offer €20 (~$21 USD) credits free which can get you a server for a few months. - -[Sign Up with Hetzner →](https://hetzner.cloud/?ref=lhLUIrkdUPhl) - -### Vultr -Vultr is a US-based company that has a great reputation for performance and value. They have a wide range of data centers around the world and a great API for automation. - -With the link below, they are offering $100 in credits -- which can get you quite a bit for a few months. - -[Sign Up with Vultr →](https://www.vultr.com/?ref=9627777-8H) - -### Digital Ocean -Digital Ocean is a US-based company that has data centers all around the world. Although their performance generally lacks compared to other providers, there are so many resources that natively support their offerings. - -With the link below, they are offering $200 in credits over 60 days. - -[Sign Up with Digital Ocean →](https://m.do.co/c/f3bad4b927ca) - -### Any other host -Spin is host-agnostic, meaning you can run Spin anywhere. If you have a preferred host, you can use them as well. Just make sure that your host meets the following requirements below. - -## Recommended Server Specs -::note -It is best to run `spin provision` against a **brand new server** with a fresh installation of Ubuntu 22.04 or newer. This will ensure that the server is in a known state and that the configuration will work as expected. -:: - -Hardware specs largely depend on your project, but even for simple apps, we recommend the following: - -- **CPU**: 1 CPU core -- **RAM**: 1GB -- **Storage**: >25GB SSD -- **Architecture**: x86_64 (64-bit) [[request ARM64 support](https://github.com/serversideup/spin/discussions/9)] -- **Operating System**: Ubuntu 22.04 LTS or newer -- **Snapshots/Backups**: Highly recommended -- **Firewall**: Configured to allow SSH and HTTPS traffic (22/tcp, 80/tcp, 443/tcp) -- **Access**: Root SSH access - -## Prepare your DNS -Once you have a server running with the host of your choice, it's recommended to configure your DNS to have two A records created pointing to the IP address of your server. - -Two records should be created: - -1. Application Domain Name (example: `myapp.example.com`) -2. Server Hostname (example: `server01.example.com`) - -::responsive-image ---- -src: /images/docs/getting-started/server-dns.png -alt: 'Configure your DNS' -maxWidth: 500 ---- -:: - -## Validate your SSH connection -Before you start, make sure you can SSH into your server **using an SSH key pair**. Many hosts do this by default, but you need to follow your hosts instructions for adding a trusted public key that can connect to your server. If you need help generating an SSH key, you can follow our guide on [Generating a Secure SSH Key](/docs/advanced/generating-a-secure-ssh-key). - - You can do this by running the following command: - -::note -We're assuming your host provisions their Ubuntu images as `root` as the default user. Use whatever standard your host uses, just as long as it has root access. -:: - -::code-panel ---- -label: "SSH into your server" ---- -```bash -ssh root@myserver01.example.com -``` -:: - -## Ensure your server is up to date -On your server, it's good practice to ensure everything is updated. Run this command below to update all packages on your server. Restarting the server is a good idea too to ensure everything is up to date. - -::code-panel ---- -label: "Update your server" ---- -```bash -apt -y update && apt -y upgrade && apt -y autoremove && apt -y autoclean && reboot -``` -:: - -## Configure server inventory and settings -::note -If your files are encrypted, you need to use the [`spin vault edit`](/docs/command-reference/vault) command to edit the file. This will decrypt the file, open it in your default editor, and then re-encrypt it when you save and close the file. -:: -Assuming you've already ran [`spin new`](/docs/command-reference/new) or [`spin init`](/docs/command-reference/init) in your project, there are two files that will need to be configured: -- `.spin-inventory.ini` -- `.spin.yml` - -#### Inventory -We call the list of our servers "inventory". This follows the [Ansible Inventory format](https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html). For example, if you wanted to add `server01.example.com` as the production server, we would configure our file to look like this and add this server to go underneath the `production_manager_servers` group: - -::note -Be sure to use your **server's hostname** (NOT your application's **domain name**) in the inventory file. This will ensure we have a dedicated DNS entry for managing your server. -:: - -::code-panel ---- -label: ".spin-inventory.ini: Add `server01.example.com` to Production" ---- -```ini -#################### -# Host Types -#################### - -[production_manager_servers] -server01.example.com - -[staging_manager_servers] -# server02.example.com - -#################### -# Swarm Roles -#################### -[swarm_managers:children] -production_manager_servers -staging_manager_servers - -#################### -# Environment -#################### -[production:children] -production_manager_servers - -[staging:children] -staging_manager_servers - -[all_servers:children] -production -staging -``` -:: - -## Configure server settings -In the `.spin.yml` file, you will find many other settings. These are required for you to change so you can connect to your server. - -#### 👉 Required to be changed -::note -**If you intend to use GitHub Actions**, we strongly recommend creating a dedicated SSH key pair for a "deploy" user (instead of using your own login, like `bob`). - -[Learn how to create a dedicated "deploy" SSH key pair →](/docs/advanced/generating-a-secure-ssh-key#generating-a-deployment-key) -:: - -| Key | Description | -|-----|---| -| `server_contact` | Change this to a valid email. **If you're using our Traefik templates**, you'll also need to change the `letsencryptresolver.acme.email` key under the `.infrastructure/conf/traefik/prod/traefik.yml` file. | -| `docker_user.authorized_ssh_keys` | OPTIONAL: Use this only if you're having something like GItHub Actions connect as the Docker User. This must be the **public key** of the your [DEPLOY user SSH keypair that you generated](/docs/advanced/generating-a-secure-ssh-key#generating-a-deployment-key). -| `users.username` | Set this to a username that you'll remember. Be sure to not use any weird characters. It might be in your best interest to match the username of your local machine. You can find this by running `whoami` in a new terminal.| -| `users.password` | Set this to the secure hash of the password you'd like to use. All users will be prompted to change on first login. Use [`spin mkpasswd`](/docs/command-reference/mkpasswd) to quickly generate a hash.| -| `users.username.authorized_ssh_keys` | Set this to **your USER _public_ SSH key value**. ⚠️ The key pair must be accessible under `~/.ssh` on your host. Most of the time the file ends in `*.pub`.| - - -::code-panel ---- -label: ".spin.yml" ---- -```yml ---- -########################################### -# Basic Server Configuration -########################################### -server_timezone: "Etc/UTC" -server_contact: changeme@example.com # 👈 Change this - -# SSH -ssh_port: "22" - -## Email Notifications -postfix_hostname: "{{ inventory_hostname }}" # ✅ Set automatically - -## Set variables below to enable external SMTP relay -# postfix_relayhost: "smtp.example.com" -# postfix_relayhost_port: "587" -# postfix_relayhost_username: "myusername" -# postfix_relayhost_password: "mysupersecretpassword" - -############################################################## -# Deploy User -############################################################## -docker_user: - username: deploy - uid: 9999 - group: deploy - secondary_groups: "docker" - gid: 9999 - ## Uncomment to set authorized SSH keys for the docker user. - # authorized_ssh_keys: - # - "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKNJGtd7a4DBHsQi7HGrC5xz0eAEFHZ3Ogh3FEFI2345 deploy" # 👈 Change this - # - "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFRfXxUZ8q9vHRcQZ6tLb0KwGHu8xjQHfYopZKLmnopQ anotherfake@key" - -############################################################## -# Users -############################################################## - -### Use the template below to set users and their authorized keys -## Passwords must be set with an encrypted hash. To do this, see the Ansible FAQ. -## Your best bet is probably using the `mkpasswd` on a Linux machine. -## https://docs.ansible.com/ansible/latest/reference_appendices/faq.html#how-do-i-generate-encrypted-passwords-for-the-user-module - -users: - - username: alice # 👈 Change this - name: Alice Smith # 👈 Change this - state: present - groups: ['adm','sudo'] - password: "$6$mysecretsalt$qJbapG68nyRab3gxvKWPUcs2g3t0oMHSHMnSKecYNpSi3CuZm.GbBqXO8BE6EI6P1JUefhA0qvD7b5LSh./PU1" # 👈 Change this - shell: "/bin/bash" - authorized_keys: - - public_key: "ssh-ed25519 AAAAC3NzaC1lmyfakeublickeyMVIzwQXBzxxD9b8Erd1FKVvu alice" # 👈 Change this - -# - username: bob -# name: Bob Smith -# state: present -# password: "$6$mysecretsalt$qJbapG68nyRab3gxvKWPUcs2g3t0oMHSHMnSKecYNpSi3CuZm.GbBqXO8BE6EI6P1JUefhA0qvD7b5LSh./PU1" -# groups: ['adm','sudo'] -# shell: "/bin/bash" -# authorized_keys: -# - public_key: "ssh-ed25519 AAAAC3NzaC1anotherfakekeyIMVIzwQXBzxxD9b8Erd1FKVvu bob" -``` -:: - -## Run `spin provison` -Once you have `.spin.yml` and `.spin-inventory.ini` configure, you're ready to provision your server(s). - -::note -Notice how we're using `--user root` in the command below. This is because most hosts provision `root` as the default user. - -By default `spin provision` will attempt to connect over SSH using the username on your workstation (how SSH works by default). Since your server doesn't come with your username already created, we need to connect as `root` on our first provision so Spin can configure the accounts configured in `.spin.yml`. -:: - -::code-panel ---- -label: "Provision your server(s)" ---- -```bash -spin provision --user root -``` -:: - -This process will automatically download [our Ansible collection](https://github.com/serversideup/ansible-collection-spin) and apply the changes on your server. - -## Confirm everything works -To confirm everything works as expected, try to SSH into your server using the username you created before. You will be prompted to change your password to a new password as soon as you login. - -::code-panel ---- -label: "Connect to your server via SSH" ---- -```bash -ssh myuser@server01.example.com -``` -:: - -If you get a connection, you should be ready to receive deployments to Docker Swarm via SSH 🥳 - -## Next Steps -If you're using the `spin deploy` deployment strategy, then take a look at our guide on how to run a simple deployment. - -[Deploy Your Project with `spin deploy` →](/docs/getting-started/run-a-simple-deployment) \ No newline at end of file diff --git a/docs/content/docs/2.getting-started/4.run-a-simple-deployment.md b/docs/content/docs/2.getting-started/4.run-a-simple-deployment.md deleted file mode 100644 index 897d193a..00000000 --- a/docs/content/docs/2.getting-started/4.run-a-simple-deployment.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -head.title: 'Run a Simple Deployment with Spin - Spin by Server Side Up' -title: 'Run a Simple Deployment with Spin' -description: 'Learn how to get your server ready for Spin deployment.' -layout: docs ---- - -# Deploying your application with Spin -::lead-p -This guide is a continuation of the "Getting Started" section of the Spin documentation. In this section, we assumme [created a project with Spin](/docs/getting-started/create-a-new-project-with-spin), and you want to use the [`spin deploy`](/docs/getting-started/create-a-new-project-with-spin#choosing-a-deployment-strategy) deployment strategy. -:: - -## Prerequisites -- Your [project has been created with Spin](/docs/getting-started/create-a-new-project-with-spin) or [you added Spin to your existing project](/docs/getting-started/add-spin-to-an-existing-project) -- Your [server has been provisioned with Spin](/docs/getting-started/preparing-your-servers-for-spin) -- You've [completed any additional steps for your project template](/docs/getting-started/create-a-new-project-with-spin#further-configuration), defined by its README - -## Running your deployment -Once you have the prerequisites in place, you can run the `spin deploy` command to deploy your application to your server. - -::code-panel ---- -label: Deploy your application with Spin ---- -```bash -spin deploy+ +
+ +## Prerequisites +- Docker is installed and running. +- Spin is installed to your system or to your project (via composer or as a node dependency). + +## Ensure your application dependencies are installed +Before you can bring up your development environment, you need to ensure your application dependencies are installed. + +::note +If you just ran `spin new` to create a project, the application dependencies will already be installed. You can skip this step. +:: + +::code-panel +--- +label: Install dependencies (this depends on your project) +--- +```bash +# PHP dependencies +spin run php composer install + +# Node dependencies +spin run node yarn install +``` +:: + +## Bring up your development environment +Once your dependencies are installed, you can bring up your development environment with the following command: + +::note +Make sure to run this command from your project directory. +:: + +::code-panel +--- +label: Bring up your development environment +--- +```bash +spin up +``` +:: + +::note +To stop your development environment, press `Ctrl+C`. +:: + +Since Spin is running Docker Compose, you can also pass any argument to the `up` command. For example, `spin up -d` will start your development environment in detached mode. See the full documentation for [spin up](/docs/command-reference/up) for more information. + +## Accessing your development environment +In order to access your development environment, review the README of the template you're using. Each template has different instructions on how to access the services. diff --git a/docs/content/docs/3.development-environment/2.running-commands-in-development.md b/docs/content/docs/3.development-environment/2.running-commands-in-development.md new file mode 100644 index 00000000..f34d9623 --- /dev/null +++ b/docs/content/docs/3.development-environment/2.running-commands-in-development.md @@ -0,0 +1,51 @@ +--- +head.title: 'Running Commands in Development - Spin by Server Side Up' +title: 'Running Commands in Development' +description: 'Learn how to run commands in your development environment with Spin.' +layout: docs +canonical: https://serversideup.net/open-source/spin/docs/development-environment/running-commands-in-development +--- + +# Running Commands in Development +::lead-p +Spin makes it easy to run commands in your development environment by following the Docker Compose CLI syntax. +:: + +## How to run commands in development +You have two options to run commands in your development environment: + +1. [`spin exec`](/docs/command-reference/exec) - This executes commands in an EXISTING container (and requires that service to be already running with `spin up`). +2. [`spin run`](/docs/command-reference/run) - This executes commands in a NEW container, then exits. + +For example, let's say you want to run `composer install` in your development environment for Laravel, you would use the following command: + +::note +If you have `spin up` running in a terminal window, you will need to run the `spin run` or `spin exec` command in a new terminal window from your project directory. +:: + +::code-panel +--- +label: Run a command in a new container +--- +```bash +# Usage: spin run**Using existing servers?** ⚠️ You must specify the IP address or hostname here. | `1.2.3.4` | Only if you are using existing servers | + +## Environments +Environments are managed under the `environments:` section in your `.spin.yml` file. You can define as many environments as you'd like or change the names of the environments. + +The most important thing to remember is the `environment` property in the `servers:` section must match an environment defined in your `.spin.yml` file. + +You can also set the `backups` property to `true` or `false` to enable or disable backups for the environment. If the `backups` property is set on a server, it will override the environment setting. + +::code-panel +--- +label: Example environments configuration in .spin.yml +--- +```yaml +############################################################## +# 🌎 Environments +############################################################## +environments: + - name: production + - name: staging + - name: development + backups: false +``` +:: + +## Advanced Server Configuration +We also give you a few other options to configure your servers that will configure the behavior for the [Spin Ansible Collection](https://github.com/serversideup/ansible-collection-spin). + +::code-panel +--- +label: .spin.yml Advanced Server Configuration +--- +```yaml +############################################################## +# 🤓 Advanced Server Configuration +############################################################## + +# Timezone and contact settings +server_timezone: "Etc/UTC" +server_contact: admin@example.com + +# If you the SSH port below, you may need to run `spin provision -p
- regions (1): read
- sizes (1): read
- ssh_key (4): create, read, update, delete | +| Create Access | 4 scopes | project / tag / image / droplet | +| Read Access | 5 scopes | snapshot / project / tag / image / droplet | +| Update Access | 3 scopes | project / image / droplet | +| **Total Custom Scopes** | **22 scopes** | | + + +## Place the token in your `.spin.yml` file +In your `.spin.yml` file, you'll find a `providers` section where you can add your DigitalOcean API token. + +::code-panel +--- +label: .spin.yml configure providers +--- +```yaml +############################################################## +# 👇 Providers - You must set at least one provider +############################################################## + +providers: + - name: digitalocean + api_token: abc123def456ghi789jkl012mno345pqr678stu901vwx234yz +``` +:: + +## Set as DO_API_TOKEN environment variable +If you prefer to set the token as an environment variable, you can also set the `DO_API_TOKEN` variable in your `.env` file, secrets manager, or wherever you store your environment variables. + +## Configure users +Make sure you configure your system users in your `.spin.yml` file. + +[Learn more about users →](/docs/server-configuration/spin-yml-usage#users) + +::code-panel +--- +label: Example users configuration in .spin.yml +--- +```yaml +############################################################## +# 👇 Users - You must set at least one user +############################################################## + +users: + - username: alice + name: Alice Smith + groups: ['sudo'] + authorized_keys: + - public_key: "ssh-ed25519 AAAAC3NzaC1lmyfakeublickeyMVIzwQXBzxxD9b8Erd1FKVvu alice" +``` +:: + +## Configuring a DigitalOcean hardware profile +By default we set you up with a very cost-effective hardware profile to get up and running quickly. + +::code-panel +--- +label: .spin.yml default Hardware Profiles +--- +```yaml +############################################################## +# 🤖 Hardware Profiles +############################################################## + +hardware_profiles: + # DigitalOcean + - name: digitalocean_1c_1gb_ubuntu2404 + provider: digitalocean + profile_config: + region: nyc3 + size: s-1vcpu-1gb + image: ubuntu-24-04-x64 + backups: true +``` +:: + +You can uncomment the defaults we give you or create/modify your own hardware profile. + +| Profile Config | Description | API Reference | +| ------------------- | ----------- | ------------------- | +| `region` | The data center and location you want to deploy your server to (pick the closest one to your customers). | See below for common examples. | +| `size` | The type of server. | See below for common examples. | +| `image` | The image to use for the server. | [DigitalOcean Images](https://docs.digitalocean.com/reference/api/api-reference/#tag/Images) | +| `backups` | Whether to enable snapshot backups for the server (may add 20% to the monthly price). | Learn more about [DigitalOcean snapshot backups](https://www.digitalocean.com/products/backups). | + +### Common Region Values +The `region` value is the `slug` of the region. You can find the full list of regions [here](https://docs.digitalocean.com/reference/api/api-reference/#tag/Regions). + +| Location | Country | Value | +|----------|---------|-------| +| New York 1 | USA | `nyc1` | +| New York 3 | USA | `nyc3` | +| San Francisco 3 | USA | `sfo3` | +| Amsterdam 3 | Netherlands | `ams3` | +| Singapore 1 | Singapore | `sgp1` | +| London 1 | UK | `lon1` | +| Frankfurt 1 | Germany | `fra1` | +| Toronto 1 | Canada | `tor1` | +| Bangalore 1 | India | `blr1` | +| Sydney 1 | Australia | `syd1` | + +### Common Size Values +::note +Make sure your server type is supported in the region you choose. Also, some of the pricing may change so be sure to check the latest pricing on the [DigitalOcean Droplet Pricing Page](https://www.digitalocean.com/pricing/droplets). +:: + +You can find the full list of server types [here](https://docs.digitalocean.com/reference/api/api-reference/#tag/Sizes). + +| Server Type | vCPUs | RAM | Storage | Traffic | Monthly Price (USD) | Description | +| ----------- | ----- | --- | ------- | ------- | ------------------ | ----------- | +| **Basic Droplets** | +| `s-1vcpu-1gb` | 1 | 1GB | 25GB | 1TB | $6.00 | Basic | +| `s-1vcpu-1gb-amd` | 1 | 1GB | 25GB | 1TB | $7.00 | Basic AMD | +| `s-1vcpu-1gb-intel` | 1 | 1GB | 25GB | 1TB | $7.00 | Basic Intel | +| `s-1vcpu-2gb` | 1 | 2GB | 50GB | 2TB | $12.00 | Basic | +| `s-2vcpu-2gb` | 2 | 2GB | 60GB | 3TB | $18.00 | Basic | +| `s-2vcpu-4gb` | 2 | 4GB | 80GB | 4TB | $24.00 | Basic | +| `s-2vcpu-4gb-amd` | 2 | 4GB | 80GB | 4TB | $28.00 | Basic AMD | +| `s-2vcpu-4gb-intel` | 2 | 4GB | 80GB | 4TB | $28.00 | Basic Intel | +| **CPU-Optimized Droplets** | +| `c-2` | 2 | 4GB | 25GB | 4TB | $42.00 | CPU-Optimized | +| `c-4` | 4 | 8GB | 50GB | 5TB | $84.00 | CPU-Optimized | +| `c-8` | 8 | 16GB | 100GB | 6TB | $168.00 | CPU-Optimized | +| `c-16` | 16 | 32GB | 200GB | 7TB | $336.00 | CPU-Optimized | + +## Configure your server +By default, we give you defaults to get up and running quickly, but you might want to make some changes. + +[Learn more about server configuration →](/docs/server-configuration/spin-yml-usage#servers) + +::code-panel +--- +label: Example server configuration in .spin.yml +--- +```yaml +############################################################## +# 👇 Servers - You must set at least one server +############################################################## + +servers: + - server_name: ubuntu-1gb-nyc-1 + environment: production + hardware_profile: digitalocean_1c_1gb_ubuntu2404 +``` +:: + +## Provision your server +Once you have everything ready, you can provision your server(s) by running this simple command: + +::code-panel +--- +label: Provision your server(s) +--- +```bash +spin provision +``` +:: + +This command will create your server(s) with DigitalOcean and configure your server(s) to be ready for deployment. There are many more options available when provisioning your server(s). To learn more see the guide below: + +[Learn more about "spin provision" →](/docs/command-reference/provision) + +## Getting ready for deployment +Now that you have a server ready, you'll want to learn how to get ready for deployment. Next steps are to choose a deployment strategy. + +[Learn which deployment strategy is right for you →](/docs/deployment/choosing-a-deployment-strategy) diff --git a/docs/content/docs/5.providers/0.hetzner.md b/docs/content/docs/5.providers/0.hetzner.md new file mode 100644 index 00000000..769d9012 --- /dev/null +++ b/docs/content/docs/5.providers/0.hetzner.md @@ -0,0 +1,188 @@ +--- +head.title: 'Create a Server with Hetzner - Spin by Server Side Up' +title: 'Hetzner' +description: 'Learn how to create a server with Hetzner.' +layout: docs +canonical: https://serversideup.net/open-source/spin/docs/providers/hetzner +--- + +# Create a Server with Hetzner +::lead-p +Hetzner is a German-based company with data centers in the EU and the US. Their pricing is very competitive and they have incredible performance. +:: + +## Create an account +The first step is to create an account with Hetzner. You can do this by going to their website and clicking the "Sign Up" button. With the link below, they offer €20 (~$21 USD) credits free which can get you a server for a few months. This is an affiliate link, meaning we get a small kickback if you sign up, but this doesn't affect our recommendations. + +[Sign Up with Hetzner →](https://hetzner.cloud/?ref=lhLUIrkdUPhl) + +## Create an API token +To create an API token, you'll need to sign in to the [Hetzner Cloud Console](https://console.hetzner.cloud/). Once signed in, select your project. + + + +Inside of the project, look for the "Security" page on the left, then click "API Tokens" at the top. + + + +When you click "Generate API Token", you'll be presented with the option to select the scopes for the token. Select "Read & Write". + + + +::note +This API token is very powerful and should be treated as a secret. Do not share this token and treat it like you would a password. +:: + +## Place the token in your `.spin.yml` file +In your `.spin.yml` file, you'll find a `providers` section where you can add your Hetzner API token. + +::code-panel +--- +label: .spin.yml configure providers +--- +```yaml +############################################################## +# 👇 Providers - You must set at least one provider +############################################################## + +providers: + - name: hetzner + api_token: abc123def456ghi789jkl012mno345pqr678stu901vwx234yz +``` +:: + +## Set as HCLOUD_TOKEN environment variable +If you prefer to set the token as an environment variable, you can also set the `HCLOUD_TOKEN` variable in your `.env` file, secrets manager, or wherever you store your environment variables. + +## Configure users +Make sure you configure your system users in your `.spin.yml` file. + +[Learn more about users →](/docs/server-configuration/spin-yml-usage#users) + +::code-panel +--- +label: Example users configuration in .spin.yml +--- +```yaml +############################################################## +# 👇 Users - You must set at least one user +############################################################## + +users: + - username: alice + name: Alice Smith + groups: ['sudo'] + authorized_keys: + - public_key: "ssh-ed25519 AAAAC3NzaC1lmyfakeublickeyMVIzwQXBzxxD9b8Erd1FKVvu alice" +``` +:: + +## Configuring a Hetzner hardware profile +By default we set you up with a very cost-effective hardware profile to get up and running quickly. + +::code-panel +--- +label: .spin.yml default Hardware Profiles +--- +```yaml +############################################################## +# 🤖 Hardware Profiles +############################################################## + +hardware_profiles: + # Hetzner + - name: hetzner_2c_2gb_ubuntu2404 + provider: hetzner + profile_config: + location: ash + server_type: cpx11 + image: ubuntu-24.04 + backups: true +``` +:: + +You can uncomment the defaults we give you or create/modify your own hardware profile. + +| Profile Config | Description | API Reference | +| ------------------- | ----------- | ------------------- | +| `location` | The data center and location you want to deploy your server to (pick the closest one to your customers). | See below for common examples. | +| `server_type` | The type of server. | See below for common examples. | +| `image` | The image to use for the server. | [Hetzner Images](https://docs.hetzner.cloud/#images-get-all-images) | +| `backups` | Whether to enable snapshot backups for the server (may add 20% to the monthly price). | Learn more about [Hetzner snapshot backups](https://docs.hetzner.com/cloud/billing/faq#how-do-you-bill-for-snapshots-and-backups). | + +### Common Location Values +The `location` value is the `name` of the location. You can find the full list of locations [here](https://docs.hetzner.cloud/#locations-get-all-locations). + +| Location | Country | Value | +| -------------- | ------- | ------ | +| Falkenstein | Germany | `fsn1` | +| Nuremberg | Germany | `nbg1` | +| Helsinki | Finland | `hel1` | +| Ashburn, VA | USA | `ash` | +| Hillsboro, OR | USA | `hil` | +| Singapore | Singapore| `sin` | + +### Common Server Types +::note +Make sure your server type is supported in the location you choose. Also, some of the pricing may change so be sure to check the latest pricing on the [Hetzner Cloud Pricing Page](https://www.hetzner.com/cloud/). +:: + +You can find the full list of server types [here](https://docs.hetzner.cloud/#server-types-get-all-server-types). + +| Server Type | vCPUs | RAM | Storage | Traffic | Monthly Price (in EUR) | +| ----------- | ----- | --- | ------- | ------- | -------------- | +| **Shared CPU - AMD (CPX)** | +| `cpx11` | 2 | 2GB | 40GB | 1TB | €4.99 | +| `cpx21` | 3 | 4GB | 80GB | 2TB | €9.49 | +| `cpx31` | 4 | 8GB | 160GB | 3TB | €16.49 | +| `cpx41` | 8 | 16GB| 240GB | 4TB | €30.49 | +| `cpx51` | 16 | 32GB| 360GB | 5TB | €60.49 | +| **Dedicated CPU (CCX)** | +| `ccx13` | 2 | 8GB | 80GB | 1TB | €12.99 | +| `ccx23` | 4 | 16GB| 160GB | 2TB | €25.99 | +| `ccx33` | 8 | 32GB| 240GB | 3TB | €49.99 | +| `ccx43` | 16 | 64GB| 360GB | 4TB | €99.99 | +| `ccx53` | 32 | 128GB| 600GB | 6TB | €199.99 | + +## Configure your server +By default, we give you defaults to get up and running quickly, but you might want to make some changes. + +[Learn more about server configuration →](/docs/server-configuration/spin-yml-usage#servers) + +::code-panel +--- +label: Example server configuration in .spin.yml +--- +```yaml +############################################################## +# 👇 Servers - You must set at least one server +############################################################## + +servers: + - server_name: ubuntu-2gb-ash-1 + environment: production + hardware_profile: hetzner_2c_2gb_ubuntu2404 +``` +:: + + +## Provision your server +Once you have everything ready, you can provision your server(s) by running this simple command: + +::code-panel +--- +label: Provision your server(s) +--- +```bash +spin provision +``` +:: + +This command will create your server(s) with Hetzner and configure your server(s) to be ready for deployment. There are many more options available when provisioning your server(s). To learn more see the guide below: + +[Learn more about "spin provision" →](/docs/command-reference/provision) + +## Getting ready for deployment +Now that you have a server ready, you'll want to learn how to get ready for deployment. Next steps are to choose a deployment strategy. + +[Learn which deployment strategy is right for you →](/docs/deployment/choosing-a-deployment-strategy) diff --git a/docs/content/docs/5.providers/0.vultr.md b/docs/content/docs/5.providers/0.vultr.md new file mode 100644 index 00000000..d00dc975 --- /dev/null +++ b/docs/content/docs/5.providers/0.vultr.md @@ -0,0 +1,205 @@ +--- +head.title: 'Create a Server with Vultr - Spin by Server Side Up' +title: 'Vultr' +description: 'Learn how to create a server with Vultr.' +layout: docs +canonical: https://serversideup.net/open-source/spin/docs/providers/vultr +--- + +# Create a Server with Vultr +::lead-p +Vultr is a US-based company that has a great reputation for performance and value. They have a wide range of data centers around the world and a great API for automation. +:: + +## Create an account +The first step is to create an account with Vultr. You can do this by going to their website and clicking the "Sign Up" button. With the link below, they offer $100 in credits. This is an affiliate link, meaning we get a small kickback if you sign up, but this doesn't affect our recommendations. + +[Sign Up with Vultr →](https://www.vultr.com/?ref=9627777-8H) + +## Create an API token +::note +This API token is very powerful and should be treated as a secret. Do not share this token and treat it like you would a password. +:: + +To create an API token, you'll need to sign in to the [Vultr Console](https://my.vultr.com/). Click on your name in the upper right, then click "API". + + + +On the API page, click the "Enable API" button. + + + +You'll see your API token on the page. Press the "Copy" button to copy the token to your clipboard. + + + +::note +This token is like a password that has full access to your account. If you want to limit the API key by IP address, you can do so by adjusting the "Access Control" settings on the API page. +:: + + +## Place the token in your `.spin.yml` file +In your `.spin.yml` file, you'll find a `providers` section where you can add your Vultr API token. + +::code-panel +--- +label: .spin.yml configure providers +--- +```yaml +############################################################## +# 👇 Providers - You must set at least one provider +############################################################## + +providers: + - name: vultr + api_token: abc123def456ghi789jkl012mno345pqr678stu901vwx234yz +``` +:: + +## Set as VULTR_API_KEY environment variable +If you prefer to set the token as an environment variable, you can also set the `VULTR_API_KEY` variable in your `.env` file, secrets manager, or wherever you store your environment variables. + +## Configure users +Make sure you configure your system users in your `.spin.yml` file. + +[Learn more about users →](/docs/server-configuration/spin-yml-usage#users) + +::code-panel +--- +label: Example users configuration in .spin.yml +--- +```yaml +############################################################## +# 👇 Users - You must set at least one user +############################################################## + +users: + - username: alice + name: Alice Smith + groups: ['sudo'] + authorized_keys: + - public_key: "ssh-ed25519 AAAAC3NzaC1lmyfakeublickeyMVIzwQXBzxxD9b8Erd1FKVvu alice" +``` +:: + +## Configuring a Vultr hardware profile +By default we set you up with a very cost-effective hardware profile to get up and running quickly. + +::code-panel +--- +label: .spin.yml default Hardware Profiles +--- +```yaml +############################################################## +# 🤖 Hardware Profiles +############################################################## + +hardware_profiles: + # Vultr + - name: vultr_1c_1gb_ubuntu2404 + provider: vultr + profile_config: + region: ord + plan: vc2-1c-1gb + os: "Ubuntu 24.04 LTS x64" + backups: true +``` +:: + +You can uncomment the defaults we give you or create/modify your own hardware profile. + +| Profile Config | Description | API Reference | +| ------------------- | ----------- | ------------------- | +| `region` | The data center and location you want to deploy your server to (pick the closest one to your customers). | See below for common examples. | +| `plan` | The type of server. | See below for common examples. | +| `os` | The image to use for the server. | [Vultr Images](https://www.vultr.com/api/#tag/images) | +| `backups` | Whether to enable snapshot backups for the server (may add 20% to the monthly price). | Learn more about [Vultr snapshot backups](https://docs.vultr.com/vps-automatic-backups). | + +### Common Region Values +The `region` value is the `id` of the region. You can find the full list of regions using the [Vultr API](https://www.vultr.com/api/#tag/region/operation/list-regions). + +| Location | Country | Value | +|----------|---------|-------| +| Amsterdam | Netherlands | `ams` | +| Atlanta | USA | `atl` | +| Bangalore | India | `blr` | +| Chicago | USA | `ord` | +| Dallas | USA | `dfw` | +| Frankfurt | Germany | `fra` | +| London | UK | `lhr` | +| Los Angeles | USA | `lax` | +| Mumbai | India | `bom` | +| New Jersey | USA | `ewr` | +| Paris | France | `cdg` | +| Seoul | South Korea | `icn` | +| Singapore | Singapore | `sgp` | +| Sydney | Australia | `syd` | +| Tokyo | Japan | `nrt` | +| Toronto | Canada | `yto` | + +### Common Plan Values + +You can find the full list of server types [here](https://www.vultr.com/api/#tag/plans/operation/list-plans). + +::note +These prices can change at anytime. Be sure to check the latest pricing on the [Vultr Pricing Page](https://www.vultr.com/pricing/). +:: + +| Server Type | vCPUs | RAM | Storage | Traffic | Monthly Price (USD) | Description | +| ----------- | ----- | --- | ------- | ------- | ------------------ | ----------- | +| **Regular Performance** | +| `vc2-1c-1gb` | 1 | 1GB | 25GB | 1TB | $5.00 | Basic SSD | +| `vc2-1c-2gb` | 1 | 2GB | 55GB | 2TB | $10.00 | Basic SSD | +| `vc2-2c-4gb` | 2 | 4GB | 80GB | 3TB | $20.00 | Basic SSD | +| `vc2-4c-8gb` | 4 | 8GB | 160GB | 4TB | $40.00 | Basic SSD | +| **High Performance (AMD/Intel)** | +| `vhp-1c-1gb` | 1 | 1GB | 25GB | 2TB | $6.00 | NVMe SSD | +| `vhp-1c-2gb` | 1 | 2GB | 50GB | 3TB | $12.00 | NVMe SSD | +| `vhp-2c-4gb` | 2 | 4GB | 100GB | 5TB | $24.00 | NVMe SSD | +| `vhp-4c-8gb` | 4 | 8GB | 180GB | 6TB | $48.00 | NVMe SSD | +| **CPU Optimized** | +| `vcp-2c-4gb` | 2 | 4GB | 75GB | 5TB | $40.00 | CPU Optimized | +| `vcp-4c-8gb` | 4 | 8GB | 150GB | 6TB | $80.00 | CPU Optimized | +| `vcp-8c-16gb` | 8 | 16GB | 300GB | 7TB | $160.00 | CPU Optimized | + +## Configure your server +By default, we give you defaults to get up and running quickly, but you might want to make some changes. + +[Learn more about server configuration →](/docs/server-configuration/spin-yml-usage#servers) + +::code-panel +--- +label: Example server configuration in .spin.yml +--- +```yaml +############################################################## +# 👇 Servers - You must set at least one server +############################################################## + +servers: + - server_name: ubuntu-1gb-ord-2 + environment: production + hardware_profile: vultr_1c_1gb_ubuntu2404 +``` +:: + +## Provision your server +Once you have everything ready, you can provision your server(s) by running this simple command: + +::code-panel +--- +label: Provision your server(s) +--- +```bash +spin provision +``` +:: + +This command will create your server(s) with Vultr and configure your server(s) to be ready for deployment. There are many more options available when provisioning your server(s). To learn more see the guide below: + +[Learn more about "spin provision" →](/docs/command-reference/provision) + +## Getting ready for deployment +Now that you have a server ready, you'll want to learn how to get ready for deployment. Next steps are to choose a deployment strategy. + +[Learn which deployment strategy is right for you →](/docs/deployment/choosing-a-deployment-strategy) diff --git a/docs/content/docs/5.providers/99.use-any-host.md b/docs/content/docs/5.providers/99.use-any-host.md new file mode 100644 index 00000000..4f396dd6 --- /dev/null +++ b/docs/content/docs/5.providers/99.use-any-host.md @@ -0,0 +1,170 @@ +--- +head.title: 'Use Any Host with Spin - Spin by Server Side Up' +title: 'Use Any Host' +description: 'Learn how to use your own servers with Spin.' +layout: docs +canonical: https://serversideup.net/open-source/spin/docs/providers/use-any-host +--- + +# Use Any Host with Spin +::lead-p +Spin is designed to work self-hosting first, which makes it compatible with almost any host. This includes running servers on a major cloud provider down to an old computer running in your grandmother's basement 🤠. Check our [server requirements](/docs/server-configuration/server-requirements) for more details. +:: + +## Server Requirements +Make sure your server and host meet the minimum server requirements. + +[View the Spin Server Requirements →](/docs/server-configuration/server-requirements) + +## Ensure you're able to connect to your server via SSH +Since you'll have to take care of the set up manually, ensure you can connect to your server via SSH. + +::code-panel +--- +label: 'Confirm SSH access' +--- +```bash +# Replace 1.2.3.4 with your server's IP address +ssh root@1.2.3.4 +``` +:: + +## Configure users +Make sure you configure your system users in your `.spin.yml` file. + +[Learn more about users →](/docs/server-configuration/spin-yml-usage#users) + +::code-panel +--- +label: Example users configuration in .spin.yml +--- +```yaml +############################################################## +# 👇 Users - You must set at least one user +############################################################## + +users: + - username: alice + name: Alice Smith + groups: ['sudo'] + authorized_keys: + - public_key: "ssh-ed25519 AAAAC3NzaC1lmyfakeublickeyMVIzwQXBzxxD9b8Erd1FKVvu alice" +``` +:: + +## You can remove "providers" and "hardware_profiles" if you want +By default, the `.spin.yml` file includes some defaults for providers and hardware profiles. You can remove these if you want to use your own. + +::code-panel +--- +label: '❌ You can remove these lines if you want' +--- +```yaml +# ############################################################## +# # 👇 Providers - You must set at least one provider +# ############################################################## + +# providers: +# - name: digitalocean +# api_token: Set token here OR delete this line and set environment variable DO_API_TOKEN + +# - name: hetzner +# api_token: Set token here OR delete this line and set environment variable HCLOUD_TOKEN + +# - name: vultr +# api_token: Set token here OR delete this line and set environment variable VULTR_API_KEY + +# ############################################################## +# # 🤖 Hardware Profiles +# ############################################################## + +# hardware_profiles: +# # Hetzner +# - name: hetzner_2c_2gb_ubuntu2404 +# provider: hetzner +# profile_config: +# location: ash +# server_type: cpx11 +# image: ubuntu-24.04 +# backups: true + +# # Vultr +# - name: vultr_1c_1gb_ubuntu2404 +# provider: vultr +# profile_config: +# region: ord +# plan: vc2-1c-1gb +# os: "Ubuntu 24.04 LTS x64" +# backups: true + +# # DigitalOcean +# - name: digitalocean_1c_1gb_ubuntu2404 +# provider: digitalocean +# profile_config: +# region: nyc3 +# size: s-1vcpu-1gb +# image: ubuntu-24-04-x64 +# backups: true +``` +:: + +## Set your server address under "servers" +If you use our native providers with Spin, it will automatically create and populate the `address` property for you. Since in this case we're providing our own server, we'll need to set the `address` property for the server in the `.spin.yml` file. + +::code-panel +--- +label: '.spin.yml' +--- +```yaml +############################################################## +# 👇 Servers - You must set at least one server +############################################################## + +servers: + - server_name: my-awesome-server + environment: production + address: 1.2.3.4 # 👈 Be sure to set this to your server's IP address or DNS hostname + # hardware_profile: hetzner_2c_2gb_ubuntu2404 (❌ You can comment or delete this line out) +``` +:: + +You can use the IP address or hostname of your server. Feel free to remove the `hardware_profile` property if you do not plan to use any providers. + +## Provision your server +Once you have everything ready, you can provision your server(s) with the following command: + +::code-panel +--- +label: Provision your server(s) +--- +```bash +spin provision -u root +``` +:: + +::note +⚠️ Most cloud providers (DigitalOcean, Vultr, Hetzner) use `root` as the default user. If your server uses a different sudo user, replace `root` with that username. +:: + +To learn more about this process, see the guide below: + +[Learn more about "spin provision" →](/docs/command-reference/provision) + +### Troubleshooting SSH Connection +If you encounter connection issues, verify your SSH access first: + +::code-panel +--- +label: Verify SSH access +--- +```bash +ssh root@1.2.3.4 # Replace with your username and server IP +``` +:: + +You should be able to connect using SSH key authentication without being prompted for a password. + +## Getting ready for deployment +Now that you have a server ready, you'll want to learn how to get ready for deployment. Next steps are to choose a deployment strategy. + +[Learn which deployment strategy is right for you →](/docs/deployment/choosing-a-deployment-strategy) \ No newline at end of file diff --git a/docs/content/docs/6.deployment/1.choosing-a-deployment-strategy.md b/docs/content/docs/6.deployment/1.choosing-a-deployment-strategy.md new file mode 100644 index 00000000..d200a6b5 --- /dev/null +++ b/docs/content/docs/6.deployment/1.choosing-a-deployment-strategy.md @@ -0,0 +1,37 @@ +--- +head.title: 'Choosing a Deployment Strategy - Spin by Server Side Up' +title: 'Choosing a Deployment Strategy' +description: 'Learn how to choose a deployment strategy for your application with Spin.' +layout: docs +canonical: https://serversideup.net/open-source/spin/docs/deployment/choosing-a-deployment-strategy +--- + +# Choosing a Deployment Strategy +::lead-p +Spin supports automated deployments and very simple deployments from your local machine. You can choose between these two strategies depending on your needs. +:: + +## Types of Deployments +There are two types of deployments: + +1. **Simple Deployments from your local machine** - We can use the [`spin deploy`](/docs/command-reference/deploy) command to deploy your application from your local machine to your server. +2. **Automated Deployments** - You can use our GitHub Actions to help you automatically deploy your application when you push to GitHub. + +| | spin deploy | GitHub Actions | +|-------------------------|----------------------|-------------------------| +| Difficulty | Very Easy | Basic Understanding of SSH & GitHub Actions required | +| Team Size | Solo-developers | Small to very large teams | +| Zero-downtime Deployments | ✅ | ✅ | +| Automated Deployments | ❌ | ✅ | + +Automated deployments are recommended for teams because they standardize the deployment process without human interaction. If you're a solo developer, you may find that [`spin deploy`](/docs/command-reference/deploy) is so easy to use you'll never need to learn the complexities of CI/CD or GitHub Actions. + +## Simple Deployments from your local machine +To learn more about our simple deployments from your local machine, see the guide below. + +[Simple Deployments from your local machine →](/docs/deployment/using-spin-deploy) + +## Automated Deployments with GitHub Actions + To learn more about our automated deployments, see the guide below. + +[Automated Deployments with GitHub Actions →](/docs/deployment/automated-deployments-with-github-actions) \ No newline at end of file diff --git a/docs/content/docs/4.advanced/1.zero-downtime-deployments-with-github-actions.md b/docs/content/docs/6.deployment/2.automated-deployments-with-github-actions.md similarity index 63% rename from docs/content/docs/4.advanced/1.zero-downtime-deployments-with-github-actions.md rename to docs/content/docs/6.deployment/2.automated-deployments-with-github-actions.md index 0061008b..c531a311 100644 --- a/docs/content/docs/4.advanced/1.zero-downtime-deployments-with-github-actions.md +++ b/docs/content/docs/6.deployment/2.automated-deployments-with-github-actions.md @@ -1,15 +1,19 @@ --- -head.title: 'Zero-downtime deployments with GitHub Actions - Spin by Server Side Up' -title: 'Zero-downtime Deployments with GitHub Actions' +head.title: 'Automated Deployments with GitHub Actions - Spin by Server Side Up' +title: 'Automated Deployments with GitHub Actions' description: 'Learn how to automate deployments with GitHub Actions.' layout: docs --- -# Zero-downtime deployments with GitHub Actions +# Automated Deployments with GitHub Actions ::lead-p Spin is compatible with any CI/CD that can build Docker images and run SSH commands on a remote server. In this guide, we cover the tools available to help make your deployments through GitHub Actions easier. :: +::note +**Looking for the easiest way to automated Laravel deployments?**
We offer a [Spin Pro template](https://getspin.pro) that is a "turn-key" solution for Laravel deployments. All of this will be automated for you and you won't need to spend any time learning the complexities of GitHub Actions. 😃 +:: + ## Important concepts **Zero-downtime deployments highly depend on your configuration with Docker.** For a zero-downtime deployment to work, there are many things that need to align in order for this to happen: @@ -23,16 +27,10 @@ Spin is compatible with any CI/CD that can build Docker images and run SSH comma Spin's official templates provide containers that are ready for zero-downtime deployments out of the box. -::responsive-image ---- -src: /images/docs/github-actions/zero-downtime-deployment.png -alt: 'GitHub Actions: Zero-downtime Deployment' -maxWidth: 500 ---- -:: + -## Spin's GitHub Actions -We provide GitHub Actions that are designed to work with Spin's structure for deployments. +## Open Source GitHub Actions +Even if you decide to not use the Spin Pro template, we offer our GitHub Actions as open source tools to help you deploy your application with Spin. - [serversideup/docker-build-action](https://github.com/marketplace/actions/docker-build-action) - A simplified syntax to build and publish your Docker images with GitHub Actions. - [serversideup/docker-swarm-deploy-github-action](https://github.com/marketplace/actions/docker-swarm-deploy-github-action) - A simplified syntax to deploy to Docker Swarm Mode via GitHub Actions. @@ -43,4 +41,9 @@ Each GitHub Action has it's own documentation on how you can implement it into y Be aware that you're taking a sensitive deployment key, putting that into GitHub actions, and allowing SSH connections from anywhere to connect to your production server. If you want to further harden your server, you may consider: - Deploying your own Self-hosted GitHub Runner -- Locking down SSH access to your server from specific IP addresses \ No newline at end of file +- Locking down SSH access to your server from specific IP addresses + +## The easiest way to deploy your Laravel application +If you're looking for the easiest way to deploy your Laravelapplication, we highly recommend using the [Spin Pro template](https://getspin.pro). This template includes a "turn-key" solution for Laravel deployments that is fully automated and requires minimal knowledge of GitHub Actions or Docker. + +[Learn more about Spin Pro →](https://getspin.pro) diff --git a/docs/content/docs/6.deployment/3.using-spin-deploy.md b/docs/content/docs/6.deployment/3.using-spin-deploy.md new file mode 100644 index 00000000..8f5db40c --- /dev/null +++ b/docs/content/docs/6.deployment/3.using-spin-deploy.md @@ -0,0 +1,26 @@ +--- +head.title: 'Using "spin deploy" - Spin by Server Side Up' +title: 'Using "spin deploy"' +description: 'Learn how to use the "spin deploy" command to deploy your application from your local machine to your server.' +layout: docs +--- + +# Using "spin deploy" +::lead-p +The `spin deploy` command is the easiest way to deploy your application without downtime while avoiding the complexities of learning CI/CD or GitHub Actions. +:: + +## When "spin deploy" is the right choice +We created `spin deploy` for the solo developer who wants an easy way to quickly deploy their application without the burden of learning CI/CD or GitHub Actions. If you're on a larger team or share your application with many developers, we highly recommend coming up with an [automated deployment strategy](/docs/deployment/automated-deployments-with-github-actions). + +## How "spin deploy" works +It's quite brilliant how `spin deploy` works. When you run this command, it will build your application locally with Docker, upload it to a temporary registry running on your machine, establish an SSH tunnel to your server, then have your server pull the new image from your local machine without any downtime. + +All of this is completed in one command without you needing to know how to configure Docker registries, CI/CD tools, or anything else. 🤯 + + + +## Learn more about "spin deploy" +To learn more about the `spin deploy` command, see the guide below. + +[Learn more about "spin deploy" →](/docs/command-reference/deploy) diff --git a/docs/content/docs/7.server-access/1.connecting-to-your-server.md b/docs/content/docs/7.server-access/1.connecting-to-your-server.md new file mode 100644 index 00000000..4514b66f --- /dev/null +++ b/docs/content/docs/7.server-access/1.connecting-to-your-server.md @@ -0,0 +1,41 @@ +--- +head.title: 'Connecting to Your Server - Spin by Server Side Up' +title: 'Connecting to Your Server' +description: 'Learn how to connect to your server.' +layout: docs +canonical: https://serversideup.net/open-source/spin/docs/server-access/connecting-to-your-server +--- + +# Connecting to Your Server +::lead-p +Spin eliminates the headache of understanding the intricacies of configuring a secure SSH connection. After you provision your server, connecting and managing your server is a breeze. +:: + +## Connect to your server +To connect to your server, you can use the `spin ssh` command. + +::code-panel +--- +label: Connect to your server +--- +```bash +ssh
+**The links below are only accessible to Spin Pro customers.**
+- [action_deploy-production.yml](https://github.com/serversideup/spin-template-laravel-pro/blob/main/blocks/github-actions/.github/workflows/action_deploy-production.yml) +- [service_docker-build-and-publish.yml](https://github.com/serversideup/spin-template-laravel-pro/blob/main/blocks/github-actions/.github/workflows/service_docker-build-and-publish.yml) +:: + +::code-panel +--- +label: Reinitialize your project +--- +```bash +spin init laravel-pro +``` +:: + +## Review your pending Git changes +Now is the time to review your pending Git changes. If you're confident everything looks good, you can go ahead and commit your changes and run your deployment. + +Once the deployment is complete, you're ready for Spin v3 and all the exciting new features! 🎉 \ No newline at end of file diff --git a/docs/content/docs/4.command-reference/base64.md b/docs/content/docs/9.command-reference/base64.md similarity index 91% rename from docs/content/docs/4.command-reference/base64.md rename to docs/content/docs/9.command-reference/base64.md index f62e3a8c..91360c7f 100644 --- a/docs/content/docs/4.command-reference/base64.md +++ b/docs/content/docs/9.command-reference/base64.md @@ -3,6 +3,7 @@ head.title: 'base64 | Command Reference - Spin by Server Side Up' title: 'base64' description: 'Command reference for "spin base64"' layout: docs +canonical: https://serversideup.net/open-source/spin/docs/command-reference/base64 --- # spin base64 ::lead-p diff --git a/docs/content/docs/4.command-reference/build.md b/docs/content/docs/9.command-reference/build.md similarity index 86% rename from docs/content/docs/4.command-reference/build.md rename to docs/content/docs/9.command-reference/build.md index 8ef633f0..5dce29e5 100644 --- a/docs/content/docs/4.command-reference/build.md +++ b/docs/content/docs/9.command-reference/build.md @@ -3,6 +3,7 @@ head.title: 'build | Command Reference - Spin by Server Side Up' title: 'build' description: 'Command reference for "spin build"' layout: docs +canonical: https://serversideup.net/open-source/spin/docs/command-reference/build --- # spin build ::lead-p diff --git a/docs/content/docs/9.command-reference/configure.md b/docs/content/docs/9.command-reference/configure.md new file mode 100644 index 00000000..16bf1aad --- /dev/null +++ b/docs/content/docs/9.command-reference/configure.md @@ -0,0 +1,101 @@ +--- +head.title: 'configure | Command Reference - Spin by Server Side Up' +title: 'configure' +description: 'Command reference for "spin configure"' +layout: docs +canonical: https://serversideup.net/open-source/spin/docs/command-reference/configure +--- +# spin configure +::lead-p +Configure various aspects of your project's deployment settings and infrastructure. +:: + +## Usage +::code-panel +--- +label: Usage for "spin configure" +--- +```bash +spin configure
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/layouts/hubdetail.vue b/docs/layouts/hubdetail.vue
new file mode 100644
index 00000000..f801931c
--- /dev/null
+++ b/docs/layouts/hubdetail.vue
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/package.json b/docs/package.json
index d6b037b6..1c5dc576 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -24,6 +24,7 @@
"surge": "^0.23.1"
},
"dependencies": {
- "@heroicons/vue": "^2.1.1"
+ "@heroicons/vue": "^2.1.1",
+ "hotkeys-js": "^3.13.7"
}
}
diff --git a/docs/public/images/docs/community-templates/serversideup.png b/docs/public/images/docs/community-templates/serversideup.png
new file mode 100644
index 00000000..33fa5d8f
Binary files /dev/null and b/docs/public/images/docs/community-templates/serversideup.png differ
diff --git a/docs/public/images/docs/community-templates/spin-laravel-basic.png b/docs/public/images/docs/community-templates/spin-laravel-basic.png
new file mode 100644
index 00000000..9ecb0c12
Binary files /dev/null and b/docs/public/images/docs/community-templates/spin-laravel-basic.png differ
diff --git a/docs/public/images/docs/community-templates/spin-laravel-pro.png b/docs/public/images/docs/community-templates/spin-laravel-pro.png
new file mode 100644
index 00000000..36807954
Binary files /dev/null and b/docs/public/images/docs/community-templates/spin-laravel-pro.png differ
diff --git a/docs/public/images/docs/community-templates/spin-nuxt.png b/docs/public/images/docs/community-templates/spin-nuxt.png
new file mode 100644
index 00000000..62879b9a
Binary files /dev/null and b/docs/public/images/docs/community-templates/spin-nuxt.png differ
diff --git a/docs/public/images/docs/community-templates/spin-official-laravel-template.png b/docs/public/images/docs/community-templates/spin-official-laravel-template.png
deleted file mode 100644
index 6165c840..00000000
Binary files a/docs/public/images/docs/community-templates/spin-official-laravel-template.png and /dev/null differ
diff --git a/docs/public/images/docs/community-templates/spin-pro-laravel.png b/docs/public/images/docs/community-templates/spin-pro-laravel.png
deleted file mode 100644
index c0e3eb3c..00000000
Binary files a/docs/public/images/docs/community-templates/spin-pro-laravel.png and /dev/null differ
diff --git a/docs/public/images/docs/digitalocean/api-sidebar.png b/docs/public/images/docs/digitalocean/api-sidebar.png
new file mode 100644
index 00000000..401e2333
Binary files /dev/null and b/docs/public/images/docs/digitalocean/api-sidebar.png differ
diff --git a/docs/public/images/docs/digitalocean/generate-token.png b/docs/public/images/docs/digitalocean/generate-token.png
new file mode 100644
index 00000000..bbabefba
Binary files /dev/null and b/docs/public/images/docs/digitalocean/generate-token.png differ
diff --git a/docs/public/images/docs/digitalocean/token-scopes.png b/docs/public/images/docs/digitalocean/token-scopes.png
new file mode 100644
index 00000000..097a7bac
Binary files /dev/null and b/docs/public/images/docs/digitalocean/token-scopes.png differ
diff --git a/docs/public/images/docs/github-actions/gha-secrets.png b/docs/public/images/docs/github-actions/gha-secrets.png
new file mode 100644
index 00000000..9700a5c4
Binary files /dev/null and b/docs/public/images/docs/github-actions/gha-secrets.png differ
diff --git a/docs/public/images/docs/hetzner/api-token-page.png b/docs/public/images/docs/hetzner/api-token-page.png
new file mode 100644
index 00000000..f806db8a
Binary files /dev/null and b/docs/public/images/docs/hetzner/api-token-page.png differ
diff --git a/docs/public/images/docs/hetzner/generate-token.png b/docs/public/images/docs/hetzner/generate-token.png
new file mode 100644
index 00000000..327aed02
Binary files /dev/null and b/docs/public/images/docs/hetzner/generate-token.png differ
diff --git a/docs/public/images/docs/hetzner/select-project.png b/docs/public/images/docs/hetzner/select-project.png
new file mode 100644
index 00000000..cbcc8617
Binary files /dev/null and b/docs/public/images/docs/hetzner/select-project.png differ
diff --git a/docs/public/images/docs/vultr/api-link.png b/docs/public/images/docs/vultr/api-link.png
new file mode 100644
index 00000000..13340b19
Binary files /dev/null and b/docs/public/images/docs/vultr/api-link.png differ
diff --git a/docs/public/images/docs/vultr/api-token.png b/docs/public/images/docs/vultr/api-token.png
new file mode 100644
index 00000000..3d8c53da
Binary files /dev/null and b/docs/public/images/docs/vultr/api-token.png differ
diff --git a/docs/public/images/docs/vultr/enable-api.png b/docs/public/images/docs/vultr/enable-api.png
new file mode 100644
index 00000000..3b2e6f29
Binary files /dev/null and b/docs/public/images/docs/vultr/enable-api.png differ
diff --git a/docs/public/images/docs/whats-spin/spin-deploy.png b/docs/public/images/docs/whats-spin/spin-deploy.png
new file mode 100644
index 00000000..09801932
Binary files /dev/null and b/docs/public/images/docs/whats-spin/spin-deploy.png differ
diff --git a/docs/public/images/docs/whats-spin/spin-maintain.png b/docs/public/images/docs/whats-spin/spin-maintain.png
new file mode 100644
index 00000000..ebe5398a
Binary files /dev/null and b/docs/public/images/docs/whats-spin/spin-maintain.png differ
diff --git a/docs/public/images/docs/whats-spin/spin-provision.png b/docs/public/images/docs/whats-spin/spin-provision.png
new file mode 100644
index 00000000..e8118cf7
Binary files /dev/null and b/docs/public/images/docs/whats-spin/spin-provision.png differ
diff --git a/docs/yarn.lock b/docs/yarn.lock
index 17320059..31bb345f 100644
--- a/docs/yarn.lock
+++ b/docs/yarn.lock
@@ -4284,6 +4284,11 @@ hosted-git-info@^7.0.0:
dependencies:
lru-cache "^10.0.1"
+hotkeys-js@^3.13.7:
+ version "3.13.7"
+ resolved "https://registry.yarnpkg.com/hotkeys-js/-/hotkeys-js-3.13.7.tgz#0188d8e2fca16a3f1d66541b48de0bb9df613726"
+ integrity sha512-ygFIdTqqwG4fFP7kkiYlvayZppeIQX2aPpirsngkv1xM1lP0piDY5QEh68nQnIKvz64hfocxhBaD/uK3sSK1yQ==
+
html-tags@^3.3.1:
version "3.3.1"
resolved "https://registry.yarnpkg.com/html-tags/-/html-tags-3.3.1.tgz#a04026a18c882e4bba8a01a3d39cfe465d40b5ce"
diff --git a/lib/actions/base64.sh b/lib/actions/base64.sh
index 799fa890..6a384c7c 100755
--- a/lib/actions/base64.sh
+++ b/lib/actions/base64.sh
@@ -9,14 +9,6 @@ action_base64() {
local action=$1
local input=$2
- if [[ "$(uname -s)" == "Darwin" ]]; then
- local base64_encode_cmd="base64 -i"
- local base64_decode_cmd="base64 -D"
- else
- local base64_encode_cmd="base64"
- local base64_decode_cmd="base64 -d"
- fi
-
case "$action" in
encode | -e)
# Check if the file exists for encoding
@@ -25,16 +17,16 @@ action_base64() {
return 1
fi
# Encode the file with base64
- $base64_encode_cmd "$input"
+ base64_encode "$input"
;;
decode | -d)
# Decode the input
if [ -f "$input" ]; then
# If it's a file, decode the file contents
- cat "$input" | $base64_decode_cmd
+ base64_decode - < "$input"
else
# If it's not a file, assume it's a base64 string and try to decode it
- echo "$input" | $base64_decode_cmd 2>/dev/null
+ echo "$input" | base64_decode - 2>/dev/null
if [ $? -ne 0 ]; then
echo "Error: Input is not a valid base64 string."
return 1
diff --git a/lib/actions/configure.sh b/lib/actions/configure.sh
new file mode 100644
index 00000000..d61314e9
--- /dev/null
+++ b/lib/actions/configure.sh
@@ -0,0 +1,220 @@
+#!/usr/bin/env bash
+
+#################################
+# Main Action Handler
+#################################
+action_configure() {
+
+ validate_project_setup
+
+ case "$1" in
+ gha)
+ shift
+ configure_gha "$@"
+ ;;
+ *)
+ show_usage "$1"
+ exit 1
+ ;;
+ esac
+
+}
+
+#################################
+# Helper Functions
+#################################
+configure_gha() {
+ local deploy_public_key_content=''
+ local environment_file=''
+
+ # Ensure environment is specified
+ if [ $# -eq 0 ]; then
+ echo "${BOLD}${RED}❌ No environment specified${RESET}"
+ echo "Usage: spin configure gha
+
+
+
+
+
+
+
+
+
+
+
+
+
+