@musare/musare
v2.1.1
Published
A modern, open-source, collaborative music app https://musare.com
Downloads
145
Readme
MusareNode
Based off of the original Musare, which utilized Meteor.
MusareNode now uses NodeJS, Express, SocketIO and VueJS - among other technologies. We have also implemented the ability to host Musare in Docker Containers.
The master branch is available at musare.com You can also find the staging branch at musare.dev
Contact
Get in touch with us via email at [email protected] or join our Discord Guild.
You can also find us on Facebook and Twitter.
Our Stack
- NodeJS
- MongoDB
- Redis
- Nginx (not required)
- VueJS
Frontend
The frontend is a vue-cli generated, vue-loader single page app, that's served over Nginx or Express. The Nginx server not only serves the frontend, but can also serve as a load balancer for requests going to the backend.
Backend
The backend is a scalable NodeJS / Redis / MongoDB app. Each backend server handles a group of SocketIO connections. User sessions are stored in a central Redis server. All data is stored in a central MongoDB server. The Redis and MongoDB servers are replicated to several secondary nodes, which can become the primary node if the current primary node goes down.
We currently only utilize 1 backend, 1 MongoDB server and 1 Redis server running for production, though it is relatively easy to expand.
Requirements
Installing with Docker: (not recommended for Windows users)
Standard Installation:
- NodeJS
_ nodemon:
yarn global add nodemon
_ node-gyp:yarn global add node-gyp
- Yarn (Windows) Yarn (Unix) (npm can also be used)
- MongoDB Currently version 4.0
- Redis (Windows) Redis (Unix)
Getting Started
Once you've installed the required tools:
git clone https://github.com/Musare/MusareNode.git
cd MusareNode
cp backend/config/template.json backend/config/default.json
Values: The
mode
should be either "development" or "production". No more explanation needed.
Thesecret
key can be whatever. It's used by express's session module.
Thedomain
should be the url where the site will be accessible from, usuallyhttp://localhost
for non-Docker.
TheserverDomain
should be the url where the backend will be accessible from, usuallyhttp://localhost:8080
for non-Docker.
TheserverPort
should be the port where the backend will listen on, should always be8080
for Docker, and is recommended for non-Docker.isDocker
if you are using Docker or not.
Theapis.youtube.key
value can be obtained by setting up a YouTube API Key. You need to use the YouTube Data API v3, and create an API key.
Theapis.recaptcha.secret
value can be obtained by setting up a ReCaptcha Site (v3).
Theapis.github
values can be obtained by setting up a GitHub OAuth Application. You need to fill in some values to create the OAuth application. The homepage is the homepage of frontend. The authorization callback url is the backend url with/auth/github/authorize/callback
added at the end. For examplehttp://localhost:8080/auth/github/authorize/callback
.
Theapis.discord.token
is the token for the Discord bot.
Theapis.discord.loggingServer
is the Discord logging server id.
Theapis.discord.loggingChannel
is the Discord logging channel id.
Theapis.mailgun
values can be obtained by setting up a Mailgun account, or you can disable it.
Theapis.spotify
values can be obtained by setting up a Spotify client id, or you can disable it.
Theredis.url
url should be left alone for Docker, and changed toredis://localhost:6379/0
for non-Docker.
Theredis.password
should be the Redis password you either put in yourstartRedis.cmd
file for Windows, or.env
for docker.
Themongo.url
needs to have the proper password for the MongoDB musare user, and for non-Docker you need to replace@musare:27017
with@localhost:27017
.
Thecookie.domain
value should be the ip or address you use to access the site, without protocols (http/https), so for examplelocalhost
.
Thecookie.secure
value should betrue
for SSL connections, andfalse
for normal http connections.cp frontend/build/config/template.json frontend/build/config/default.json
Values:
TheserverDomain
should be the url where the backend will be accessible from, usuallyhttp://localhost:8080
for non-Docker. ThefrontendDomain
should be the url where the frontend will be accessible from, usuallyhttp://localhost
for docker orhttp://localhost:80
for non-Docker. ThefrontendPort
should be the port where the frontend will be accessible from, should always be port81
for Docker, and is recommended to be port80
for non-Docker. Therecaptcha.key
value can be obtained by setting up a ReCaptcha Site (v3). Thecookie.domain
value should be the ip or address you use to access the site, without protocols (http/https), so for examplelocalhost
. Thecookie.secure
value should betrue
for SSL connections, andfalse
for normal http connections. ThesiteSettings.logo
should be the path to the logo image, by default it is/assets/wordmark.png
. ThesiteSettings.siteName
should be the name of the site. ThesiteSettings.socialLinks.
github
,twitter
,facebook
andgithub
are set to the official Musare accounts by default but can be changed.
Now you have different paths here.
Installing with Docker
Configuration
To configure docker simply cp .env.example .env
and configure the .env file to match your settings in backend/config/default.json
.
The configurable ports will be how you access the services on your machine, or what ports you will need to specify in your nginx files when using proxy_pass.
COMPOSE_PROJECT_NAME
should be a unique name for this installation, especially if you have multiple instances of Musare on the same machine.
FRONTEND_MODE
should be either dev
or prod
(self-explanatory).
Build the backend and frontend Docker images (from the main folder)
docker-compose build
Set up the MongoDB database
Set the password for the admin/root user.
In
.env
set the environment variable ofMONGO_ROOT_PASSWORD
.Set the password for the musare user (the one the backend will use).
In
.env
set the environment variable ofMONGO_USER_USERNAME
andMONGO_USER_PASSWORD
.Start the database (in detached mode), which will generate the correct MongoDB users.
docker-compose up -d mongo
Start redis and the mongo client in the background, as we usually don't need to monitor these for errors
docker-compose up -d mongoclient redis
Start the backend and frontend in the foreground, so we can watch for errors during development
docker-compose up backend frontend
You should now be able to begin development! The backend is auto reloaded when you make changes and the frontend is auto compiled and live reloaded by webpack when you make changes. You should be able to access Musare in your local browser at
http://<docker-machine-ip>:8080/
where<docker-machine-ip>
can be found below:Docker for Windows / Mac: This is just
localhost
Docker ToolBox: The output of
docker-machine ip default
If you are using linting extensions in IDEs/want to run yarn lint
, you need to install the following locally (outside of Docker):
yarn global add eslint
yarn add eslint-config-airbnb-base
Standard Installation
Steps 1-4 are things you only have to do once. The steps to start servers follow.
In the main folder, create a folder called
.database
Create a file called
startMongo.cmd
in the main folder with the contents:"C:\Program Files\MongoDB\Server\3.2\bin\mongod.exe" --dbpath "D:\Programming\HTML\MusareNode\.database"
Make sure to adjust your paths accordingly.
Set up the MongoDB database
Start the database by executing the script
startMongo.cmd
you just madeConnect to Mongo from a command prompt
mongo admin
Create an admin user
db.createUser({user: 'admin', pwd: 'PASSWORD_HERE', roles: [{role: 'userAdminAnyDatabase', db: 'admin'}]})
Connect to the Musare database
use musare
Create the musare user
db.createUser({user: 'musare', pwd: 'OTHER_PASSWORD_HERE', roles: [{role: 'readWrite', db: 'musare'}]})
Exit
exit
Add the authentication
In
startMongo.cmd
add--auth
at the end of the first line
In the folder where you installed Redis, edit the
redis.windows.conf
file. In there, look for the propertynotify-keyspace-events
. Make sure that property is uncommented and has the valueEx
. It should look likenotify-keyspace-events Ex
when done.Create a file called
startRedis.cmd
in the main folder with the contents:"D:\Redis\redis-server.exe" "D:\Redis\redis.windows.conf" "--requirepass" "PASSWORD"
And again, make sure that the paths lead to the proper config and executable. Replace
PASSWORD
with your Redis password.
Non-docker start servers
Automatic
- If you are on Windows you can run
windows-start.cmd
or just double click thewindows-start.cmd
file and all servers will automatically start up.
Manual
Run
startRedis.cmd
andstartMongo.cmd
to start Redis and Mongo.In a command prompt with the pwd of frontend, run
yarn run dev
In a command prompt with the pwd of backend, run
nodemon
Extra
Below is a list of helpful tips / solutions we've collected while developing MusareNode.
Mounting a non-standard directory in Docker Toolbox on Windows
Docker Toolbox usually only gives VirtualBox access to C:/Users
of your
local machine. So if your code is located elsewere on your machine,
you'll need to tell Docker Toolbox how to find it. You can use variations
of the following commands to give Docker Toolbox access to those files.
First lets ensure the machine isn't running
docker-machine stop default
Next we'll want to tell the machine about the folder we want to share.
"C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" sharedfolder add default --name "d/Projects/MusareNode" --hostpath "D:\Projects\MusareNode" --automount
Now start the machine back up and ssh into it
docker-machine start default && docker-machine ssh default
Tell boot2docker to mount our volume at startup, by appending to its startup script
sudo tee -a /mnt/sda1/var/lib/boot2docker/profile >/dev/null <<EOF mkdir -p /d/Projects/MusareNode mount -t vboxsf -o uid=1000,gid=50 d/Projects/MusareNode /d/Projects/MusareNode EOF
Restart the docker machine so that it uses the new shared folder
docker-machine restart default
You now should be good to go!
Fixing the "couldn't connect to docker daemon" error
Some people have had issues while trying to execute the docker-compose
command.
To fix this, you will have to run docker-machine env default
.
This command will print various variables.
At the bottom, it will say something similar to @FOR /f "tokens=*" %i IN ('docker-machine env default') DO @%i
.
Run this command in your shell. You will have to do this command for every shell you want to run docker-compose
in (every session).
Running Musare locally without using Docker
Install nodemon globally
yarn global add nodemon
Install webpack globally
yarn global add webpack
Install node-gyp globally (first check out https://github.com/nodejs/node-gyp#installation)
yarn global add node-gyp
.Run
yarn run bootstrap
to install dependencies and dev-dependencies for both the frontend and backend.Either execute
yarn run dev:frontend
andyarn run dev:backend
separately, or in parallel withyarn dev
.
Calling Toasts
You can call Toasts using our custom package, vue-roaster
, using the following code:
import { Toast } from "vue-roaster";
Toast.methods.addToast("", 0);
Set user role
When setting up you will need to grant yourself the admin role, using the following commands:
docker-compose exec mongo mongo admin
use musare
db.auth("MUSAREDBUSER","MUSAREDBPASSWORD")
db.users.update({username: "USERNAME"}, {$set: {role: "admin"}})