edshot99/eBooru
1
0
Fork 0
forked from e621ng/e621ng
Code Issues 11 Releases 1 Activity

[Readme] Add docker for windows specifics

Browse Source
This commit is contained in:
Earlopain 2021-11-16 00:20:21 +01:00
parent 7f4114736d
commit 36812a234e
No known key found for this signature in database
GPG Key ID: 6CFB948E15246897
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,12 +1,18 @@
## Installation (Easy mode - For development environments)
#### Prerequisites
* Latest version of Docker ([download](https://docs.docker.com/get-docker))
* Latest version of Docker ([download](https://docs.docker.com/get-docker)). The WSL2 backend on Windows is required.
* Latest version of Docker Compose ([download](https://docs.docker.com/compose/install))
* Git ([download](https://git-scm.com/downloads))
If you are on Windows Docker Compose is already included, you do not need to install it yourself.
If you are on Linux/MacOS you can probably use your package manager.
#### Windows development environment
Developing on Windows requires some special setup to get good response times. Unfortunately performance across file systems is not great for WSL2 and recieving inotify events isn't possible. This leads to an all-around unpleasant experience. Read more about this [here](https://docs.docker.com/desktop/windows/wsl/#best-practices).
To mitigate this you can install a WSL distribution and clone the project inside there. Executing docker inside the container will still work, without directly accessing the host. Access the code with [Remote Development for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) or simply use the network address `\\wsl$`.
#### Installation
1. Download and install the prerequisites.
2. Clone the repo with `git clone https://github.com/zwagoth/e621ng.git`.