Skip to content

Commit

Permalink
Merge pull request #151 from ynput/fix/improve-docker-setup
Browse files Browse the repository at this point in the history
Improve docker server deployment
  • Loading branch information
m-u-r-p-h-y authored Mar 18, 2024
2 parents 154a689 + 8baba55 commit 36f4905
Showing 1 changed file with 19 additions and 23 deletions.
42 changes: 19 additions & 23 deletions website/docs/admin_server_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<Tabs
groupId="platforms"
defaultValue="linux"
values={[
{label: 'Windows', value: 'win'},
{label: 'Linux', value: 'linux'},
{label: 'Mac', value: 'mac'},
]}>
groupId="platforms"
defaultValue="linux"
values={[
{label: 'Windows', value: 'win'},
{label: 'Linux', value: 'linux'},
{label: 'Mac', value: 'mac'},
]}>

<TabItem value="linux">
<ReactMarkdown>


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/)
Expand All @@ -43,18 +41,17 @@ import TabItem from '@theme/TabItem';
</ReactMarkdown>
</TabItem>


<TabItem value="win">
<ReactMarkdown>

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. 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`.

</ReactMarkdown>
Expand All @@ -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`.
Expand All @@ -77,10 +74,9 @@ import TabItem from '@theme/TabItem';

</Tabs>


## 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
Expand Down

0 comments on commit 36f4905

Please sign in to comment.