Skip to content

Commit

Permalink
docs: move prerequisites at the beginning of the section
Browse files Browse the repository at this point in the history
  • Loading branch information
jagoral committed Feb 19, 2025
1 parent 100e831 commit b2a9022
Showing 1 changed file with 23 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,29 @@ This dual-framework support is particularly beneficial when:
Local deployments should only be used for development and testing purposes. For production deployments, we recommend using CI/CD pipelines (like GitHub Actions, GitLab CI, or Bitbucket Pipelines) as they provide better credentials' security, a controlled deployment environment, version control integration, and automated validation checks. You can read more about it in the [CI/CD guide](/guides/multistore/tooling-and-concepts/deployment/ci-cd).
::

### Prerequisites

1. **Docker**
- Docker must be installed and running on your machine

2. **Cloud Credentials**
- Find your credentials in the [Alokai Console](/console/instance/settings/deployment-variables)
- Use staging projects for local testing
- Set up environment variables or provide them via CLI flags:
- `CLI_CLOUD_USERNAME` or `--cloud-username`
- `CLI_CLOUD_PASSWORD` or `--cloud-password`

3. **Docker Registry**
- Default registry: `registry.vuestorefront.cloud`
- Can be customized using `--docker-registry-url` flag or `CLI_DOCKER_REGISTRY_URL` environment variable

4. **Configuration Verification**
- Double-check `alokai.config.json` configuration
- Verify `projectName` matches intended deployment target
- Confirm `region` selection is appropriate for testing

### Deployment Command

One of the great things about Alokai is how simple it makes deployments! The basic deployment command is:

```bash
Expand Down Expand Up @@ -200,25 +223,6 @@ The ability to deploy locally makes development and testing much faster! You can
For security reasons, you must never commit credentials to version control, share credentials with unauthorized team members or use production credentials for local testing. Always prefer using environment variables.
::

### Prerequisites for Local Deployment

1. **Cloud Credentials**
- Find your credentials in the [Alokai Console](/console/instance/settings/deployment-variables)
- Use staging projects for local testing
- Set up environment variables or provide them via CLI flags:
- `CLI_CLOUD_USERNAME` or `--cloud-username`
- `CLI_CLOUD_PASSWORD` or `--cloud-password`

2. **Docker Registry**
- Default registry: `registry.vuestorefront.cloud`
- Can be customized using `--docker-registry-url` flag or `CLI_DOCKER_REGISTRY_URL` environment variable

3. **Configuration Verification**
- Double-check `alokai.config.json` configuration
- Verify `projectName` matches intended deployment target
- Confirm `region` selection is appropriate for testing


::card{title="Next: Deployment - CI/CD" icon="tabler:number-3-small" }

#description
Expand Down

0 comments on commit b2a9022

Please sign in to comment.