Bluemedia/muse
1
0
Fork 0
mirror of https://github.com/BluemediaDev/muse.git synced 2025-04-17 03:53:57 +02:00
Code Issues Projects Releases Packages 1 Wiki Activity

Update README

Browse source
This commit is contained in:
Max Isom 2021-12-16 15:03:31 -05:00
parent f6376048eb
commit a73fd840f7
No known key found for this signature in database
GPG key ID: 25C9B1A7F6798880
2 changed files with 20 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.github/workflows/publish.yml vendored
View file

@ -1,4 +1,4 @@
name: Publish Docker image name: Make release & publish Docker image
on: on:
push: push:
@ -21,7 +21,6 @@ jobs:
id: changelog_reader id: changelog_reader
uses: mindsers/changelog-reader-action@v2 uses: mindsers/changelog-reader-action@v2
with: with:
validation_depth: 10
version: ${{ steps.tag_name.outputs.current_version }} version: ${{ steps.tag_name.outputs.current_version }}
path: ./CHANGELOG.md path: ./CHANGELOG.md

24
README.md
View file

@ -30,12 +30,25 @@ Muse is written in TypeScript. You can either run Muse with Docker (recommended)
Muse will log a URL when run. Open this URL in a browser to invite Muse to your server. Muse will DM the server owner after it's added with setup instructions. Muse will log a URL when run. Open this URL in a browser to invite Muse to your server. Muse will DM the server owner after it's added with setup instructions.
#### Versioning
The `master` branch acts as the developing / bleeding edge branch and is not guaranteed to be stable.
When running a production instance, I recommend that you use the [latest release](https://github.com/codetheweb/muse/releases/).
#### Docker #### Docker
There are a variety of image tags available:
- `:2`: versions >= 2.0.0
- `:2.1`: versions >= 2.1.0 and < 2.2.0
- `:2.1.1`: an exact version specifier
- `:latest`: whatever the latest version is
(Replace empty config strings with correct values.) (Replace empty config strings with correct values.)
```bash ```bash
docker run -it -v "$(pwd)/data":/data -e DISCORD_TOKEN='' -e SPOTIFY_CLIENT_ID='' -e SPOTIFY_CLIENT_SECRET='' -e YOUTUBE_API_KEY='' codetheweb/muse docker run -it -v "$(pwd)/data":/data -e DISCORD_TOKEN='' -e SPOTIFY_CLIENT_ID='' -e SPOTIFY_CLIENT_SECRET='' -e YOUTUBE_API_KEY='' codetheweb/muse:latest
``` ```
This starts Muse and creates a data directory in your current directory. This starts Muse and creates a data directory in your current directory.
@ -47,7 +60,7 @@ version: '3.4'
services: services:
muse: muse:
image: codetheweb/muse image: codetheweb/muse:latest
restart: always restart: always
volumes: volumes:
- ./muse:/data - ./muse:/data
@ -64,9 +77,10 @@ services:
1. `git clone https://github.com/codetheweb/muse.git && cd muse` 1. `git clone https://github.com/codetheweb/muse.git && cd muse`
2. Copy `.env.example` to `.env` and populate with values 2. Copy `.env.example` to `.env` and populate with values
3. `yarn install` (or `npm i`) 3. I recommend checking out a tagged release with `git checkout v[latest release]`
4. `yarn build` (or `npm run build`) 4. `yarn install` (or `npm i`)
5. `yarn start` (or `npm run start`) 5. `yarn build` (or `npm run build`)
6. `yarn start` (or `npm run start`)
**Note**: if you're on Windows, you may need to manually set the ffmpeg path. See [#345](https://github.com/codetheweb/muse/issues/345) for details. **Note**: if you're on Windows, you may need to manually set the ffmpeg path. See [#345](https://github.com/codetheweb/muse/issues/345) for details.