diff --git a/website/docs/admin_server_deployment.md b/website/docs/admin_server_deployment.md index 1e00c113..c92c3e10 100644 --- a/website/docs/admin_server_deployment.md +++ b/website/docs/admin_server_deployment.md @@ -7,34 +7,32 @@ sidebar_label: Server deployment import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; - ## Requirements -- Docker with the compose plugin. To install the latest Docker, you can use this script: [https://get.docker.com](https://get.docker.com) -- GNU Make (on Linux and MacOS) -- If you use a stand-alone `docker-compose` script instead of the compose plugin, make sure to use `docker-compose` wherever `docker compose` is used in this tutorial. -- For production, using Linux is highly recommended. However, for evaluation purposes, Windows with WSL (Windows Subsystem for Linux) can be used. +- Docker with the compose plugin. To install the latest Docker, you can use this script: [https://get.docker.com](https://get.docker.com) +- GNU Make (on Linux and MacOS) +- If you use a stand-alone `docker-compose` script instead of the compose plugin, make sure to use `docker-compose` wherever `docker compose` is used in this tutorial. +- For production, using Linux is highly recommended. However, for evaluation purposes, Windows with WSL (Windows Subsystem for Linux) can be used. ## Installation +groupId="platforms" +defaultValue="linux" +values={[ +{label: 'Windows', value: 'win'}, +{label: 'Linux', value: 'linux'}, +{label: 'Mac', value: 'mac'}, +]}> - 1. Clone [ayon-docker repository](https://github.com/ynput/ayon-docker) to your local machine. 2. Tweak the `docker-compose.yml` file according to your requirements. 3. You may use the `.env` file to set environment variables. -4. Install addons to the `addons` directory. -5. Modify the default settings in the `settings/template.json` file (see provisioning page). +4. Manually install addons to the `addons` directory or automatically install later on (recommended). +5. Modify the default settings in the `settings/template.json` file (see [provisioning page](https://ayon.ynput.io/docs/admin_server_provisioning/#configuration-file)). 6. Run the stack using `docker compose up -d` 7. Run `make setup` 8. Once the setup is complete, navigate to [http://localhost:5000/](http://localhost:5000/) @@ -43,7 +41,6 @@ import TabItem from '@theme/TabItem'; - @@ -51,10 +48,10 @@ import TabItem from '@theme/TabItem'; 2. Tweak the `docker-compose.yml` file according to your requirements. 3. You may use the `.env` file to set environment variables. 4. Comment-out or delete the `- "/etc/localtime:/etc/localtime:ro"` line from the `docker-compose.yml` file. -5. Install addons to the `addons` directory. -6. Modify the default settings in the `settings/template.json` file (see provisioning page). +5. Manually install addons to the `addons` directory or automatically install later on (recommended). +6. Modify the default settings in the `settings/template.json` file (see [provisioning page](https://ayon.ynput.io/docs/admin_server_provisioning/#configuration-file)). 7. Run the stack using `docker compose up -d` -8. Run `manage.ps1 setup` to set up the server. +8. Run `manage.ps1 setup` to set up the server. If you get a permission error, you may need to set your execution policy to `RemoteSigned` by running `Set-ExecutionPolicy RemoteSigned` in PowerShell [stackoverflow](https://stackoverflow.com/questions/10635/why-are-my-powershell-scripts-not-running). 9. Once the setup is complete, navigate to [http://localhost:5000/](http://localhost:5000/) in your web browser and log in as `admin/admin`. @@ -66,8 +63,8 @@ import TabItem from '@theme/TabItem'; 1. Clone [ayon-docker repository](https://github.com/ynput/ayon-docker) to your local machine. 2. Tweak the `docker-compose.yml` file according to your requirements. 3. You may use the `.env` file to set environment variables. -4. Install addons to the `addons` directory. -5. Modify the default settings in the `settings/template.json` file (see provisioning page). +4. Manually install addons to the `addons` directory or automatically install later on (recommended). +5. Modify the default settings in the `settings/template.json` file (see [provisioning page](https://ayon.ynput.io/docs/admin_server_provisioning/#configuration-file)). 6. Run the stack using `docker compose up -d` 7. Run `make setup` 8. Once the setup is complete, navigate to [http://localhost:5000/](http://localhost:5000/) in your web browser and log in as `admin/admin`. @@ -77,10 +74,9 @@ import TabItem from '@theme/TabItem'; - ## Updates -If you are using our official docker images and docker compose for AYON server deployment, updating is as easy as +If you are using our official docker images and docker compose for AYON server deployment, updating is as easy as ```shell docker pull ynput/ayon:latest #replace with corresponding image version if you don't want latest