You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Updated readme instructions for windows (#73)
Added additional instructions in the Readme based on issues encountered
during installation on Windows.
Specifically creating a new .env file and handling version mismatching.
Copy file name to clipboardExpand all lines: README.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,14 @@ This will clone the repository from GitHub. Once cloned, navigate into the new d
25
25
cd kos-base
26
26
```
27
27
28
+
#### 1.5. Environment Variables
29
+
As part of the repository we have an example environment file with a '.example' extension.
30
+
Create a copy of this file with the example extension removed.
31
+
32
+
'''shell
33
+
cp .env.example .env
34
+
'''
35
+
28
36
#### 2. Build Docker image
29
37
Files provided in the repository are pre-configured to build Kos from the application source code previously cloned in the last step. The Kos Docker image is built in steps. Once each step completes, it's stored in a cache for later to speed up following builds.
30
38
@@ -33,6 +41,9 @@ To build the application image, run:
33
41
docker compose build
34
42
```
35
43
44
+
If the build fails, the composer dependencies may be out of date.
45
+
A short term solution is to delete the "composer.lock" file.
46
+
36
47
#### 3. Run Kos
37
48
With the application image built, we can now stand up Kos with necessary dependencies. To run Kos, run:
0 commit comments