Merge "JUNITS for JSONDELETE class"
[music.git] / docs / single.rst
1 ======================
2 Single VM/Site install
3 ======================
4 Local Installation
5 ------------------
6 Prerequisites
7
8 If you are using a VM make sure it has at least 8 GB of RAM (It may work with 4 GB, but with 2 GB it
9 does give issues).
10
11 Instructions
12
13 - Create MUSIC Install dir /opt/app/music
14 - Open /etc/hosts as sudo and enter the name of the vm alongside localhost in the line for 127.0.0.1. E.g. 127.0.0.1 localhost music-1. Some of the apt-get installation seem to require this.
15 - Ensure you have OpenJDK 8 on your machine.
16 - Download Apache Cassandra 3.0, install into /opt/app/music and follow these instructions http://cassandra.apache.org/doc/latest/getting_started/installing.html till and including Step
17 - By the end of this you should have Cassandra working.
18 - Create a music.properties file and place it in /opt/app/music/etc/. Here is a sample of the file:
19
20 music.properties::
21
22     music.properties
23     my.id=0
24     all.ids=0
25     my.public.ip=localhost
26     all.public.ips=localhost
27     ########################
28     # Optional current values are defaults
29     ######################################
30     # If using docker this would point to the specific docker name.
31     #cassandra.host=localhost
32     #music.ip=localhost
33  
34     #debug=true
35     #music.rest.ip=localhost
36     #lock.lease.period=6000
37     # Cassandra Login - Do not user cassandra/cassandra
38     cassandra.user=cassandra1
39     cassandra.password=cassandra1
40     # AAF Endpoint
41     #aaf.endpoint.url=<aaf url>
42
43 - Make a dir /opt/app/music/logs MUSIC dir with MUSIC logs will be created in this dir after MUSIC starts.
44 - Build the MUSIC.war and place in tomcat webapps dir. 
45 - Authentications/AAF Setup For Authentication setup.
46 - Start tomcat and you should now have MUSIC running.
47
48 Extra Cassandra information for Authentication:
49
50 To create first user in Cassandra
51
52 1. Edit conf/Cassandra.yaml file::
53
54     authenticator: PasswordAuthenticator
55     authorizer: CassandraAuthorizer
56
57
58 2. Restart Cassandra
59 3. Login to cqlsh with default credentials::
60
61     cqlsh -u cassandra -p cassandra
62
63 4. To change default user create new user with the following command.::
64
65     CREATE USER new_user WITH PASSWORD ‘new_password’ SUPERUSER;
66
67 5. Change password for default user ‘Cassandra’ so that no one will be able to login::
68    
69     ALTER USER cassandra WITH PASSWORD ‘SomeLongRandomStringNoonewillthinkof’;
70
71 6. Provide the new user credentials to Music. Update music.properties file and uncomment or add the following::
72
73     cassandra.user=<new_user>
74     cassandra.password=<new_password>
75
76 To access keyspace through cqlsh, login with credentials that are passed to MUSIC while creating the keyspace.
77
78 Continue with `Authentication <./automation.rst>`_
79
80
81
82