MyFavMirrors
/
owntone-server
mirror of https://github.com/owntone/owntone-server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
owntone-server/docs/clients/web-interface.md

76 lines
3.1 KiB
Markdown
Raw Normal View History

[docs] Fix minor mistakes
2024-02-28 07:34:42 -05:00
# Web Interface
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
Mobile friendly player web interface for [OwnTone](http://owntone.github.io/owntone-server/) build
with [Vue.js](https://vuejs.org), [Bulma](http://bulma.io).
[docs] Split docs into multiple files and publish with gh-actions
2022-03-20 07:00:31 -04:00
You can find the web interface at [http://owntone.local:3689](http://owntone.local:3689)
Fix address error generated by mkdocs - mk2 Fix "does not appear to be an IPv4 or IPv6 address"
2023-06-22 16:21:27 -04:00
or alternatively at http://SERVER_ADDRESS:3689.
[docs] Split docs into multiple files and publish with gh-actions
2022-03-20 07:00:31 -04:00
Use the web interface to control playback, trigger manual library rescans, pair
with remotes, select speakers, authenticate with Spotify, etc.
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
## Screenshots
[docs] Split docs into multiple files and publish with gh-actions
2022-03-20 07:00:31 -04:00
![Now playing](../assets/images/screenshot-now-playing.png){: class="zoom" }
![Queue](../assets/images/screenshot-queue.png){: class="zoom" }
![Music browse](../assets/images/screenshot-music-browse.png){: class="zoom" }
![Music artists](../assets/images/screenshot-music-artists.png){: class="zoom" }
![Music artist](../assets/images/screenshot-music-artist.png){: class="zoom" }
![Music albums](../assets/images/screenshot-music-albums.png){: class="zoom" }
![Music albums options](../assets/images/screenshot-music-albums-options.png){: class="zoom" }
![Music album](../assets/images/screenshot-music-album.png){: class="zoom" }
[docs] Fix minor mistakes
2024-02-28 07:34:42 -05:00
![Spotify](../assets/images/screenshot-music-spotify.png){: class="zoom" }
[docs] Split docs into multiple files and publish with gh-actions
2022-03-20 07:00:31 -04:00
![Audiobooks authors](../assets/images/screenshot-audiobooks-authors.png){: class="zoom" }
![Audiobooks](../assets/images/screenshot-audiobooks-books.png){: class="zoom" }
![Podcasts](../assets/images/screenshot-podcasts.png){: class="zoom" }
![Podcast](../assets/images/screenshot-podcast.png){: class="zoom" }
![Files](../assets/images/screenshot-files.png){: class="zoom" }
![Search](../assets/images/screenshot-search.png){: class="zoom" }
![Menu](../assets/images/screenshot-menu.png){: class="zoom" }
![Outputs](../assets/images/screenshot-outputs.png){: class="zoom" }
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
## Usage
You can find OwnTone's web interface at [http://owntone.local:3689](http://owntone.local:3689)
Fix address error generated by mkdocs - mk2 Fix "does not appear to be an IPv4 or IPv6 address"
2023-06-22 16:21:27 -04:00
or alternatively at http://SERVER_ADDRESS:3689.
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
## Build Setup
The source is located in the `web-src` folder.
[docs] Fix minor mistakes
2024-02-28 07:34:42 -05:00
```bash
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
cd web-src
```
The web interface is built with [Vite](https://vitejs.dev/), makes use of Prettier for code formatting
and ESLint for code linting (the project was set up following the guide [ESLint and Prettier with Vite and Vue.js 3](https://vueschool.io/articles/vuejs-tutorials/eslint-and-prettier-with-vite-and-vue-js-3/)
[docs] Fix minor mistakes
2024-02-28 07:34:42 -05:00
```bash
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
# install dependencies
npm install
# Serve with hot reload at localhost:3000
# (assumes that OwnTone server is running on localhost:3689)
npm run serve
# Serve with hot reload at localhost:3000
# (with remote OwnTone server reachable under owntone.local:3689)
[docs] Fix minor mistakes
2024-02-28 07:34:42 -05:00
export VITE_OWNTONE_URL=http://owntone.local:3689 npm run serve
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
# Build for production with minification (will update web interface
# in "../htdocs")
npm run build
# Format code
npm run format
# Lint code (and fix errors that can be automatically fixed)
npm run lint
```
After running `npm run serve` the web interface is reachable at [localhost:3000](http://localhost:3000).
[docs] Fix minor mistakes
2024-02-28 07:34:42 -05:00
By default it expects **OwnTone** to be running at [localhost:3689](http://localhost:3689) and proxies all
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
JSON API calls to this location.
If the server is running at a different location you have to set the env variable `VITE_OWNTONE_URL`.