Build your Astro Site with Docker
Docker is a tool to build, deploy, and run applications using containers.
Docker images and containers can be deployed to many different platforms, like AWS, Azure, and Google Cloud. This recipe won’t cover how to deploy your site to a specific platform but will show you how to set up Docker for your project.
Prerequisites
Section titled Prerequisites- Docker installed on your local machine. You can find installation instructions for your operating system here.
- A Dockerfile in your project. You can learn more about Dockerfiles here and use the Dockerfiles in the following section as a starting point.
Creating a Dockerfile
Section titled Creating a DockerfileCreate a file called Dockerfile
in your project’s root directory. This file contains the instructions to build your site, which will differ depending on your needs. This guide can’t show all possible options but will give you starting points for SSR and static mode.
If you’re using another package manager than npm, you’ll need to adjust the commands accordingly.
This Dockerfile will build your site and serve it using Node.js on port 3000
and therefore requires the Node adapter installed in your Astro project.
Adding a .dockerignore
Section titled Adding a .dockerignoreAdding a .dockerignore
file to your project is best practice. This file describes which files or folders should be ignored in the Docker COPY
or ADD
commands, very similar to how .gitignore
works. This speeds up the build process and reduces the size of the final image.
This file should go in the same directory as the Dockerfile
itself. Read the .dockerignore
documentation for extra info
Static
Section titled StaticApache (httpd)
Section titled Apache (httpd)The following Dockerfile will build your site and serve it using Apache htppd on port 80
with the default configuration.
NGINX
Section titled NGINXIn order to build the Dockerfile above, you’ll also need to create a configuration file for NGINX. Create a folder called nginx
in your project’s root directory and create a file called nginx.conf
inside.
Multi-stage build (using SSR)
Section titled Multi-stage build (using SSR)Here’s an example of a more advanced Dockerfile that, thanks to Docker’s multi-stage builds, optimizes the build process for your site by only reinstalling the npm dependencies when the source code changes. This can reduce the build time even by minutes, depending on the size of your dependencies.
Recipe
Section titled Recipe- Build your container by running the following command in your project’s root directory. Use any name for
<your-astro-image-name>
:
This will output an image, which you can run locally or deploy to a platform of your choice.
- To run your image as a local container, use the following command.
Replace <local-port>
with an open port on your machine. Replace <container-port>
with the port exposed by your Docker container (3000
, 80
, or 8080
in the above examples.)
You should be able to access your site at http://localhost:<local-port>
.
- Now that your website is successfully built and packaged in a container, you can deploy it to a cloud provider. See the Google Cloud deployment guide for one example, and the Deploy your app page in the Docker docs.
More recipes
-
Share State Between Islands
Learn how to share state across framework components with Nano Stores.
-
Add an RSS feed
Add an RSS feed to your Astro site to let users subscribe to your content.
-
Installing a Vite or Rollup plugin
Learn how you can import YAML data by adding a Rollup plugin to your project.
-
Build Forms With API Routes
Learn how to use JavaScript to send form submissions to an API Route
-
Build HTML Forms in Astro Pages
Learn how to build HTML forms and handle submissions in your frontmatter
-
Use Bun with Astro
Learn how to use Bun with your Astro site.
-
Call endpoints from the server
Learn how to call endpoints from the server in Astro.
-
Verify a Captcha
Learn how to create an API route and fetch it from the client.
-
Build your Astro Site with Docker
Learn how to build your Astro site using Docker.
-
Add icons to external links
Learn how to install a rehype plugin to add icons to external links in your Markdown files
-
Add i18n features
Use dynamic routing and content collections to add internationalization support to your Astro site.
-
Add Last Modified Time
Build a remark plugin to add the last modified time to your Markdown and MDX.
-
Add Reading Time
Build a remark plugin to add reading time to your Markdown or MDX files.
-
Share State Between Astro Components
Learn how to share state across Astro components with Nano Stores.