This repository contains the source code of the Freesound website.
Freesound is a project by the Music Technology Group (MTG), Universitat Pompeu Fabra (UPF).
License
All the source code in this repository is licensed under the GNU Affero General Public License v3. Some of the dependencies might have their own licenses. See the _LICENSE folder for more details.
Authors
For a list of authors please check out the contributors page.
Development
Freesound is composed of a number of different services which can be run and orchestrated using Docker. The main service is provided by the web
container which runs the Freesound Django application. Check out this blog post for some information about the Freesound technology stack. If you're going to do development on Freesound, please check the DEVELOPERS file for some guidelines.
Below are instructions for setting up a local Freesound installation for development. It is assumed that you have a working Docker installation.
Setting up Freesound for development in 13 easy steps
-
Clone source code repository
git clone [email protected]:MTG/freesound.git cd freesound
-
Create a directory named
freesound-data
inside the repository foldermkdir freesound-data
-
Download the Freesound development data zip file (~20GB) and uncompress it inside
freesound-data
. You should get permission to download this file from Freesound admins. File structure should look like this:freesound/ freesound/freesound-data/ freesound/freesound-data/analysis/ freesound/freesound-data/avatar/ ...
-
Download Freesound development similarity index and the Freesound tag recommendation models and place their contents under
freesound-data/similarity_index/
andfreesound-data/tag_recommendation_models
directories respectively (you'll need to create the directories). You should get permission to download these files from Freesound admins. -
Rename
freesound/local_settings.example.py
file so you can customise Django settings if needed and create a.env
file with your local user UID and other useful settings. These other settings includeCOMPOSE_PROJECT_NAME
andLOCAL_PORT_PREFIX
which can be used to allow parallell local installations running on the same machine (provided that these to variables are different in the local installations), andFS_BIND_HOST
which you should set to0.0.0.0
if you need to access your local Fresound services from a remote machine.cp freesound/local_settings.example.py freesound/local_settings.py echo FS_USER_ID=$(id -u) > .env echo COMPOSE_PROJECT_NAME=freesound >> .env echo LOCAL_PORT_PREFIX= >> .env echo FS_BIND_HOST= >> .env
-
[Optional] Create API credentials for the 3rd party services listed below and add them to your own
freesound/local_settings.py
file (checksettings.py
to know the config parameter names that you need to fill in):- Mapbox
- Recaptcha
-
Build the base Freesound Docker image
make -C docker
-
Build all Docker containers. The first time you run this command can take a while as a number of Docker images need to be downloaded and things need to be installed and compiled.
docker-compose build
-
Download the Freesound development database dump (~50MB), run the database container and load the data into it. You should get permission to download this file from Freesound admins.
docker-compose up -d db docker-compose run --rm db psql -h db -U freesound -d freesound -f /freesound-data/db_dev_dump/freesound_dev_db-2018-01-12-anonymised.sql
-
Update database by running Django migrations
docker-compose run --rm web python manage.py migrate
-
Create a superuser account to be able to login to the local Freesound website and to the admin site
docker-compose run --rm web python manage.py createsuperuser
-
Run services
🎉 docker-compose up
When running this command, the most important services that make Freesound work will be run locally. This includes the web application and database, but also the search engine, cache manager, queue manager and asynchronous workers including audio processing. You should be able to point your browser to http://localhost:8000
and see the Freesound website up and running!
-
Build the search index so you can search for sounds and forum posts
# Open a new terminal window so the services started in the previous step keep running docker-compose run --rm web python manage.py reindex_search_engine_sounds docker-compose run --rm web python manage.py reindex_search_engine_forum
After following the steps you'll have a functional Freesound installation up and running, with the most relevant services properly configured. You can run Django's shell plus command like this:
docker-compose run --rm web python manage.py shell_plus
Because the web
container mounts a named volume for the home folder of the user running the shell plus process, command history should be kept between container runs :)
-
(extra step) The steps above will get Freesound running, but to save resources in your local machine some non-essential services will not be started by default. If you look at the
docker-compose.yml
file, you'l see that some services are marked with the profileanalyzers
orall
. These services include sound similarity, search results clustering and the audio analyzers. To run these services you need to explicitely telldocker-compose
using the--profile
(note that some services need additional configuration steps (see Freesound analysis pipeline section inDEVELOPERS.md
):docker-compose --profile analyzers up # To run all basic services + sound analyzers docker-compose --profile all up # To run all services
Running tests
You can run tests using the Django test runner in the web
container like that:
docker-compose run --rm web python manage.py test --settings=freesound.test_settings