Cutlery/Kyoo
1
0
Fork 0
mirror of https://github.com/zoriya/Kyoo.git synced 2025-07-07 10:14:13 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add .env.example to release (#984)

Browse Source
This commit is contained in:
Zoe Roux 2025-06-10 14:05:25 +02:00 committed by GitHub
parent 4029f4bb43
commit d6c5e5281d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.github/workflows/release.yml vendored
View File

@ -19,12 +19,9 @@ jobs:
VERSION=${VERSION%.*} # Remove minor version VERSION=${VERSION%.*} # Remove minor version
sed "s/edge/$VERSION/" -i docker-compose.yml sed "s/edge/$VERSION/" -i docker-compose.yml
- uses: actions/upload-artifact@v4
with:
name: docker-compose.yml
path: ./docker-compose.yml
- name: Upload release artifacts - name: Upload release artifacts
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
with: with:
files: ./docker-compose.yml files: |
./docker-compose.yml
./.env.example

6
INSTALLING.md
View File

@ -3,8 +3,8 @@
1. Install docker & docker-compose 1. Install docker & docker-compose
2. Download the 2. Download the
[`docker-compose.yml`](https://github.com/zoriya/kyoo/releases/latest/download/docker-compose.yml) and [`docker-compose.yml`](https://github.com/zoriya/kyoo/releases/latest/download/docker-compose.yml) and
[`.env`](https://raw.githubusercontent.com/zoriya/Kyoo/master/.env.example) files [`.env`](https://github.com/zoriya/kyoo/releases/latest/download/env.example) files
3. Fill the `.env` file with your configuration options 3. Fill the `.env` file with your configuration options. Ensure it's named `.env` (nothing before the dot)
4. Look at [Hardware Acceleration section](#Hardware-Acceleration) if you need it 4. Look at [Hardware Acceleration section](#Hardware-Acceleration) if you need it
5. Look at [FAQ](#FAQ) if you need it, 5. Look at [FAQ](#FAQ) if you need it,
6. Run `docker compose up -d` and see kyoo at `http://localhost:8901` 6. Run `docker compose up -d` and see kyoo at `http://localhost:8901`
@ -23,7 +23,7 @@ Those files can be put in any directory of your choice.
Those files are: Those files are:
- A `docker-compose.yml` (simply download docker-compose.yml from [the latest release](https://github.com/zoriya/kyoo/releases/latest/download/docker-compose.yml)). - A `docker-compose.yml` (simply download docker-compose.yml from [the latest release](https://github.com/zoriya/kyoo/releases/latest/download/docker-compose.yml)).
- A `.env` file that you will need to **fill**. Look at the example [.env.example](https://raw.githubusercontent.com/zoriya/Kyoo/master/.env.example) - A `.env` file that you will need to **fill**. Look at the example [.env.example](https://github.com/zoriya/kyoo/releases/latest/download/env.example). It's name NEEDS to be `.env` (nothing before the dot)
> If you want an explanation of what are those files, you can read the following: > If you want an explanation of what are those files, you can read the following:
> The `docker-compose.yml` file describes the different services of Kyoo, where they should be downloaded and their start order. \ > The `docker-compose.yml` file describes the different services of Kyoo, where they should be downloaded and their start order. \