Docker and Docker Compose
Note
In principle, it should be possible to run the REST API on any port, as described below, but in the current release it may be necessary to leave it on the default port of 8098
The Music Catalogue API and UI are available as Docker container images. Please see the following Docker Hub repositories for more information:
To run the Music Catalogue UI and the associated Web Service in Docker:
- Create a folder to contain the key files, UI configuration file, database and Docker Compose file
- Create a database in that folder using the instructions in the "SQLite Database" section
- Create a user in the database using the instructions in the "Web Service" section
- Create the key files, UI configuration file and Docker Compose file in that folder, as described below
- Create an "Export" folder and an "Export\Reports" folder to hold exported data files
When completed, the folder structure should look as follows:
- To enable album lookup via the AudioDB (see the sections on "Album Lookup" and "Application Configuration File"):
- Sign up for a RapidAPI key at RapidAPI
- Create a text file called "rapidapi.key" containing a single line holding the key
- If the album lookup isn't being used, skip this step
- Note that without a key, any lookup for an album that isn't already held locally will result in an "album not found" error on the search page
- To use the Retailer Location Maps:
- Create a Google Maps API key
- Create a text file called "mapsapi.key" containing a single line holding the key
- If the location maps aren't being used, skip this step
- Note that without a key, the retailer location maps will show a "something went wrong" error
- Create a JSON configuration file for the UI called "ui-config.json":
{
"api": {
"baseUrl": "http://localhost:8098"
},
"region": {
"locale": "en-GB",
"currency": "GBP",
"geocodingLanguage": "en",
"geocodingRegion": "GB"
}
}- Adjust the port number to a free port on the local machine
- Set the locale settings to suit
- The following is an example Docker Compose file that can be used to run the Music Catalogue service and UI from the published Docker images
- It should be saved as "docker-compose.yml" in the folder containing the other files, created in the previous steps
services:
music-ui:
container_name: musiccatalogueui
image: davewalker5/musiccatalogueui:latest
restart: always
ports:
- "8087:3000"
volumes:
- C:\MusicCatalogue\ui-config.json:/opt/musiccatalogue.ui/config.json
music-api:
container_name: musiccatalogueservice
image: davewalker5/musiccatalogueapisqlite:latest
restart: always
ports:
- "8098:80"
volumes:
- C:\MusicCatalogue\:/var/opt/musiccatalogue.api/- Make sure the "music-api" port number matches the port number in the UI configuration file, created in the previous step
- Make sure the "music-ui" port number, 8087 in this example, is an unused port on the local machine
- The example assumes that the key and configuration files are in the local folder C:\MusicCatalogue
- This should be changed as appropriate
- To start the application, open a terminal window, change to the folder and run the following command:
docker compose --project-directory . up -d- The output should look similar to this:
C:\MusicCatalogue>docker compose --project-directory . up -d
[+] Building 0.0s (0/0) docker:default
[+] Running 3/3
✔ Network musiccatalogue_default Created 0.0s
✔ Container musiccatalogueui Started 0.1s
✔ Container musiccatalogueservice Started 0.1s
- With the application running, browsing to the following URL should show the login page:
http://localhost:8087
- Replace the port number, 8087, with the port used for the "music-ui" in the Docker Compose file
- To stop the application, from the same folder run the following command:
docker compose --project-directory . down- The output should look similar to this:
C:\MusicCatalogue>docker compose --project-directory . down
[+] Running 3/3
✔ Container musiccatalogueservice Removed 0.4s
✔ Container musiccatalogueui Removed 10.5s
✔ Network musiccatalogue_default Removed