# LocalOps Documentation

- [First steps](https://docs.localops.co/index.md)
- [How it works](https://docs.localops.co/howitworks.md)
- [Support](https://docs.localops.co/support.md)
- [Compatibility](https://docs.localops.co/compatibility.md)
- [Shared responsibilities](https://docs.localops.co/environment/shared-responsibilities.md): Who owns what in a LocalOps environment - your team, LocalOps, and your cloud provider - across apps, infrastructure and security.
- [SaaS environments](https://docs.localops.co/use-cases/public-saas.md): How to offer your software as a service on yourdomain.com
- [Single tenant deployments](https://docs.localops.co/use-cases/dedicated-infrastructure.md): How to give dedicated isolated infrastructure for specific customers in your cloud
- [BYOC enterprise delivery](https://docs.localops.co/use-cases/byoc.md): How to deploy your SaaS service remotely on customer cloud environments
- [Enable self hosting for enterprise customers](https://docs.localops.co/use-cases/self-hosted.md): How to offer self-hosted version of your service to enterprise
- [Preview pull requests](https://docs.localops.co/use-cases/ephemeral.md): How to spin up ephemeral full-stack enviornments to test pull requests in isolation
- [Environment for each developer](https://docs.localops.co/use-cases/environment-per-developer.md): Give every developer their own full-stack environment in your cloud, and let them create, deploy, debug and tear it down themselves.
- [Migrate from Heroku](https://docs.localops.co/migrate-to-aws/from-heroku.md): Step-by-step guide to migrate your Heroku application and Postgres database to AWS using LocalOps
- [Migrate from Render](https://docs.localops.co/migrate-to-aws/from-render.md): Step-by-step guide to migrate your Render application and Postgres database to AWS using LocalOps
- [Migrate from Vercel](https://docs.localops.co/migrate-to-aws/from-vercel.md): Step-by-step guide to migrate your Vercel application and database to AWS using LocalOps
- [Migrate from Fly.io](https://docs.localops.co/migrate-to-aws/from-fly.md): Step-by-step guide to migrate your Fly.io application and Postgres database to AWS using LocalOps
- [Node/ExpressJS](https://docs.localops.co/guides/languages/node.md)
- [Python/Django](https://docs.localops.co/guides/languages/python.md)
- [Go/gin](https://docs.localops.co/guides/languages/go.md)
- [.NET Framework/ASP.NET](https://docs.localops.co/guides/languages/dotnet.md): Step-by-step guide to setting up a Dockerfile for a .NET Framework application on Windows Server 2022
- [Elixir/Phoenix](https://docs.localops.co/guides/languages/elixir.md): Step-by-step guide to setting up a Dockerfile for an Elixir/Phoenix application (with an Erlang/Cowboy variant) and deploying it via LocalOps.
- [Next.js](https://docs.localops.co/guides/spa/nextjs.md)
- [ReactJS](https://docs.localops.co/guides/spa/react.md)
- [Angular](https://docs.localops.co/guides/spa/angular.md)
- [Ember](https://docs.localops.co/guides/spa/ember.md)
- [VueJS](https://docs.localops.co/guides/spa/vue.md)
- [Install on Windows](https://docs.localops.co/cli/install-windows.md)
- [Install on macOS](https://docs.localops.co/cli/install-macos.md)
- [Install on Linux](https://docs.localops.co/cli/install-linux.md)
- [Usage](https://docs.localops.co/cli/usage.md)
- [Amazon Web Services (AWS)](https://docs.localops.co/accounts/aws.md)
- [Google Cloud Platform (GCP)](https://docs.localops.co/accounts/gcp.md): Connect your Google Cloud account with LocalOps
- [Microsoft Azure](https://docs.localops.co/accounts/azure.md)
- [Connect GitHub account](https://docs.localops.co/accounts/connect-github.md)
- [Connect GitLab account](https://docs.localops.co/accounts/connect-gitlab.md): Connect gitlab.com or your self-managed GitLab to LocalOps for push-to-deploy, merge request previews, and deployment status.
- [What's inside?](https://docs.localops.co/environment/inside.md)
- [Create environment](https://docs.localops.co/environment/create.md)
- [Protected environments](https://docs.localops.co/environment/protected-environments.md): Limit an environment, such as production, to the people you choose, with a role of its own
- [Environment security controls on AWS](https://docs.localops.co/environment/security.md): What "production grade" means in a LocalOps environment on AWS - isolation, keyless access, network, encryption, least-privilege IAM, secrets, backups and audit logging, all enabled by default.
- [Environment security controls on GCP](https://docs.localops.co/environment/security-gcp.md): What "production grade" means in a LocalOps environment on GCP - isolation, keyless access, network, encryption, least-privilege IAM, secrets, backups and audit logging, all enabled by default.
- [Logs](https://docs.localops.co/environment/monitoring/logs.md)
- [Metrics](https://docs.localops.co/environment/monitoring/metrics.md)
- [Alerts](https://docs.localops.co/environment/monitoring/alerts.md)
- [Crashes](https://docs.localops.co/environment/monitoring/crashes.md)
- [View your environment's resources](https://docs.localops.co/environment/infra-resources/aws.md): Use LocalOps resource tags to find, inventory and analyze the cost of your environment's AWS resources
- [Extend using Terraform/Pulumi](https://docs.localops.co/environment/extend-with-iac.md)
- [Delete environment](https://docs.localops.co/environment/delete.md)
- [Eject out of LocalOps](https://docs.localops.co/environment/eject.md)
- [Create service](https://docs.localops.co/environment/services/create.md): Learn how to create a new service
- [Deploy a service](https://docs.localops.co/environment/services/deploy.md)
- [ops.json magic](https://docs.localops.co/environment/services/ops-json.md): Define health checks, configure ingress, cloud resources and more with a simple JSON file
- [Web service](https://docs.localops.co/environment/services/web.md)
- [Internal service](https://docs.localops.co/environment/services/internal.md)
- [Workers](https://docs.localops.co/environment/services/workers.md)
- [Job](https://docs.localops.co/environment/services/job.md)
- [Cron Job](https://docs.localops.co/environment/services/cronjob.md)
- [Running DB migrations](https://docs.localops.co/environment/services/db-migrations.md): Package your database migrations as a separate image and run them as an init job or a manual job service
- [Autoscaling](https://docs.localops.co/environment/services/autoscaling.md): Scale a service's replicas on CPU, memory and time-of-day windows with the autoscaling block in ops.json
- [S3 Buckets](https://docs.localops.co/environment/services/aws/s3.md): Provision S3 buckets as object storage for files and attachments
- [RDS (Postgres, MySQL & SQL Server)](https://docs.localops.co/environment/services/aws/rds.md): Provision Amazon RDS databases - Postgres/MySQL/SQL Server
- [Aurora (Postgres & MySQL)](https://docs.localops.co/environment/services/aws/aurora.md): Provision Amazon Aurora clusters - MySQL/Postgres
- [Elasticache Redis, Valkey & Memcache](https://docs.localops.co/environment/services/aws/elasti-cache.md): Provision AWS Elastic Cache clusters - Redis/Valkey/Memcache
- [OpenSearch](https://docs.localops.co/environment/services/aws/opensearch.md): Provision Amazon OpenSearch domains for search and analytics
- [SQS Queues](https://docs.localops.co/environment/services/aws/sqs.md): Provision queues - Standard/FIFO in AWS
- [SNS Topics](https://docs.localops.co/environment/services/aws/sns.md): Provision Amazon SNS topics for pub/sub communication
- [Run Docker Images](https://docs.localops.co/environment/services/docker.md)
- [Use Helm charts](https://docs.localops.co/environment/services/helm-charts.md)
- [Deploying Micro Services](https://docs.localops.co/environment/services/micro-services.md)
- [BEAM clustering](https://docs.localops.co/environment/services/beam-clustering.md): Cluster your Elixir/Erlang services with a single ops.json key so nodes discover each other over distributed Erlang.
- [Secrets](https://docs.localops.co/environment/services/secrets.md)
- [Custom domain](https://docs.localops.co/environment/services/custom-domain.md)
- [Client IP](https://docs.localops.co/environment/services/client-ip.md): How to read the real client IP from incoming HTTP requests across direct, SSL-passthrough, and CDN setups.
- [Delete service](https://docs.localops.co/environment/services/delete.md)
- [How to instrument](https://docs.localops.co/environment/services/instrument-service.md): Expose custom metrics from your services to the inbuilt Prometheus + Grafana stack so they appear automatically in your environment's dashboards.
- [Java](https://docs.localops.co/environment/services/instrument/java.md): Expose JVM and custom Prometheus metrics from a Java service running on LocalOps, and visualize them with a community Grafana dashboard.
- [Python](https://docs.localops.co/environment/services/instrument/python.md): Expose process, runtime, and custom Prometheus metrics from a Python service running on LocalOps, and visualize them with a community Grafana dashboard.
- [Node.js](https://docs.localops.co/environment/services/instrument/nodejs.md): Expose Node.js runtime and custom Prometheus metrics from a Node.js service running on LocalOps, and visualize them with a community Grafana dashboard.
- [Golang](https://docs.localops.co/environment/services/instrument/golang.md): Expose Go runtime, process, and custom Prometheus metrics from a Go service running on LocalOps, and visualize them with a community Grafana dashboard.
- [.NET](https://docs.localops.co/environment/services/instrument/dotnet.md): Expose .NET runtime and custom Prometheus metrics from a .NET service running on LocalOps, and visualize them with a community Grafana dashboard.
- [Erlang](https://docs.localops.co/environment/services/instrument/erlang.md): Expose BEAM VM and custom Prometheus metrics from an Erlang service running on LocalOps, and visualize them with a community Grafana dashboard.
- [Understanding roles](https://docs.localops.co/team/understanding-roles.md): How organization roles, project roles and protected environments work together to control who can do what in LocalOps.
- [Invite team members](https://docs.localops.co/team/invite-users.md): Invite people to your organization, choose their organization role and project access, and change it later
- [Project members](https://docs.localops.co/team/project-members.md): Add people to a project, set their project role, change it, and remove them
- [Owner and Admin restrictions](https://docs.localops.co/team/owner-admin-restrictions.md): Lower an Owner's or Admin's access in a single project or environment, and lift it again
- [Remove a user](https://docs.localops.co/team/remove-user.md): Remove someone from your LocalOps organization
- [Audit Log](https://docs.localops.co/team/audit-logs.md)
- [Environment creation](https://docs.localops.co/troubleshoot/create-environment.md)
- [Custom Domain](https://docs.localops.co/troubleshoot/custom-domain.md)
- [I don't have a Docker Image](https://docs.localops.co/bring-your-helm-charts/first-steps/no-docker.md)
- [I have a Docker Image](https://docs.localops.co/bring-your-helm-charts/first-steps/have-docker.md)
- [I have a docker compose setup](https://docs.localops.co/bring-your-helm-charts/first-steps/have-docker-compose.md)
- [I have a Helm Chart](https://docs.localops.co/bring-your-helm-charts/first-steps/have-helm.md)
- [Publish helm chart to ECR](https://docs.localops.co/bring-your-helm-charts/publish/ecr.md)
- [Python + React](https://docs.localops.co/bring-your-helm-charts/tutorials/python-react.md)
- [NodeJs + React](https://docs.localops.co/bring-your-helm-charts/tutorials/node-react.md)
- [Go + React](https://docs.localops.co/bring-your-helm-charts/tutorials/go-react.md)
- [MySQL](https://docs.localops.co/bring-your-helm-charts/databases/mysql.md)
- [Postgres](https://docs.localops.co/bring-your-helm-charts/databases/postgres.md)
- [MongoDB](https://docs.localops.co/bring-your-helm-charts/databases/mongodb.md)
- [Redis](https://docs.localops.co/bring-your-helm-charts/databases/redis.md)
- [Database Migration](https://docs.localops.co/bring-your-helm-charts/database-migration.md)
- [Environment Variables](https://docs.localops.co/bring-your-helm-charts/env-vars.md)
- [Multiple Helm Charts](https://docs.localops.co/bring-your-helm-charts/multiple-helm-charts.md)
- [Terms of Service](https://docs.localops.co/terms.md): Terms governing your use of the LocalOps platform and services.
- [Privacy Policy](https://docs.localops.co/privacy-policy.md): How LocalOps collects, uses, maintains, protects, and discloses information from users of the LocalOps platform.
- [Sub-processors](https://docs.localops.co/sub-processors.md): The third-party services LocalOps uses to operate its platform and process customer data.
- [Data security](https://docs.localops.co/security.md)
- [Getting Started](https://docs.localops.co/api/getting-started.md): Authentication, response format and error handling for the LocalOps API
- [Common workflows](https://docs.localops.co/api/workflows.md): End to end recipes for the LocalOps API
- [Health Check](https://docs.localops.co/api-reference/health/health-check.md): Unauthenticated liveness check. No `Authorization` header is required.
- [Create Environment](https://docs.localops.co/api-reference/environments/create-environment.md): Create an environment in one of your connected cloud accounts.
- [Get Environment](https://docs.localops.co/api-reference/environments/get-environment.md): Read an environment's identity, lifecycle state, network edges and workload identity.
- [Delete Environment](https://docs.localops.co/api-reference/environments/delete-environment.md): Delete an environment and tear down its infrastructure.
- [Create Service](https://docs.localops.co/api-reference/services/create-service.md): Create a service inside an environment. The service is registered with the provisioner and persisted, service level secrets are optionally seeded, and an immediate first deployment is optionally triggered.
- [Get Service Status](https://docs.localops.co/api-reference/services/get-service-status.md): Poll a service's runtime status. This is the only endpoint that hydrates live state from the environment, so `kube_svc_alias`, `kube_secret`, `kube_dep_secret`, `kube_preview_dep_secret`, `namespace_name`, `ops_dependencies` and `ip_whitelist` are populated here and empty or omitted everywhere else.
- [Delete Service](https://docs.localops.co/api-reference/services/delete-service.md): Delete a service. The request creates a delete operation, asks the provisioner to tear the service down and moves the service to `delete_pending`. The teardown itself continues asynchronously.
- [Update Service](https://docs.localops.co/api-reference/services/update-service.md): Update a service's configuration. Send only the fields you want to change. The database update and the provisioner update run in one transaction.
- [Deploy Service](https://docs.localops.co/api-reference/deployments/deploy-service.md): Trigger a deployment for a specific service within an environment.
- [Get Deployment](https://docs.localops.co/api-reference/deployments/get-deployment.md): Poll a deployment. Scoped to your account, so no environment is needed in the path.
- [Cancel Deployment](https://docs.localops.co/api-reference/deployments/cancel-deployment.md): Stop a deployment that has not finished.
- [Get Operation](https://docs.localops.co/api-reference/operations/get-operation.md): Read one operation's status and error.
- [Get Operation Logs](https://docs.localops.co/api-reference/operations/get-operation-logs.md): Read an operation's logs page by page, for example to show build and rollout output in your own CI.
- [Get Custom Domains](https://docs.localops.co/api-reference/custom-domains/get-custom-domains.md): Read the service's active and pending custom domain, each hydrated with live DNS records.
- [Add Custom Domain](https://docs.localops.co/api-reference/custom-domains/add-custom-domain.md): Register a custom domain for a service and get back the DNS records to create. Create the returned records in your DNS provider, then verify the domain.
- [Delete Custom Domain](https://docs.localops.co/api-reference/custom-domains/delete-custom-domain.md): Detach a custom domain from a service and remove it.
- [Verify Custom Domain](https://docs.localops.co/api-reference/custom-domains/verify-custom-domain.md): Check DNS and certificate validation for the domain and, once verified, deploy its ingress and retire the previously active domain for the service.
- [Force Deploy Custom Domain](https://docs.localops.co/api-reference/custom-domains/force-deploy-custom-domain.md): Deploy a custom domain **without** checking its DNS. This is an escape hatch for domains you have verified yourself, when the live DNS check keeps failing.
- [Get Environment Secrets](https://docs.localops.co/api-reference/secrets/get-environment-secrets.md): Read the environment's secret set. Environment level secrets are shared by all services in the environment.
- [Replace Environment Secrets](https://docs.localops.co/api-reference/secrets/replace-environment-secrets.md): Replace the environment's entire secret set. This is a full write and not a merge - any key you omit is removed. Read the current set, modify it, then write the whole set back.
- [Get Service Secrets](https://docs.localops.co/api-reference/secrets/get-service-secrets.md): Read a service's secret set. Service level secrets are scoped to a single service and are separate from the environment level set.
- [Replace Service Secrets](https://docs.localops.co/api-reference/secrets/replace-service-secrets.md): Replace the service's entire secret set. This is a full write and not a merge - any key you omit is removed.
- [License tokens](https://docs.localops.co/api/no-access-delivery/license-tokens.md)

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.