Navidrome Website
Running in a container locally
You can run this project inside a Docker container, the container runs with a volume bound to the project's source folder. This approach doesn't require you to install any dependencies other than Docker Desktop on Windows and Mac, and Docker Compose on Linux.
-
Build the docker image
docker-compose build
-
Run the built image
docker-compose up
NOTE: You can run both commands at once with
docker-compose up --build
. -
Verify that the service is working.
Open your web browser and type
http://localhost:1313
in your navigation bar, This opens a local instance of the project's homepage. You can now make changes to the source code and those changes will immediately show up in your browser after you save.
Cleanup
To stop Docker Compose, on your terminal window, press Ctrl + C.
To remove the produced images run:
docker-compose rm
For more information see the Docker Compose documentation.
Setting up local environment
- Install dependencies:
- Clone this repository
git clone https://github.com/navidrome/website cd website
- If you want to do SCSS edits and want to publish these, you need to install
PostCSS
npm install
NOTE: For Windows users, you need to be sure to install the extended edition of Hugo.
This can be done viachoco install hugo-extended
Running the website locally
Building and running the site locally requires a recent extended
version of Hugo.
You can find out more about how to install Hugo for your environment in our
Getting started guide.
Once you've made your working copy of the site repo, from the repo root folder, run:
hugo server
This will start Hugo and serve the site at http://localhost:1313
Credits
Photos from Unsplash by: