readme

README.md

@@ -2,9 +2,34 @@
 
 This package contains all R3 configuration variables which should be unique to each deployment of R3
 
+#Authentication
+
 config.js contains the client password
 
 secure.js should only be included 'server' side and contains the server password.
 
 For updates to the API to be successful (saving, deleting of components and uploads), these passwords have to match.
 
+#Nginx Config
+
+The nginx config for r3-api lives in this package under nginx subfolder. The default location for installation of all r3 packages is /usr/share/cybafelo.
+
+When you install into this location (i.e. /usr/share/cybafelo/r3, /usr/share/cybafelo/r3-api ...) you will not have to modify the nginx configuration.
+
+#SSL
+
+For SSL web server deployments you are free to use the files:
+
+cybafelo.local.cert.pem -> this is the certificate file in the nginx config
+cybafelo.local.key.pem -> this is the private key used to generate the certificate
+
+For your browser to accept this certificate and not display a red warning, you can import the following certificate chain file into the CA section of your browser options.
+
+ca-chain.cert.pem
+
+And no - R3 does NOT support the silly web browser from a giant corrupt software company that now owns github.com
+
+#Hosts
+
+The hosts file contains the host aliases for localhost - it allows the nginx config to determine the mode (live or development), application (r3-api, r3-editor, etc) and the domain associated with the SSL certificate (in our case cybafelo.local)
+

ca-chain.cert.pem

@@ -0,0 +1,74 @@
+-----BEGIN CERTIFICATE-----
+MIIGfTCCBGWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwgcgxCzAJBgNVBAYTAkRF
+MQ8wDQYDVQQIDAZCZXJsaW4xDzANBgNVBAcMBkJlcmxpbjEfMB0GA1UECgwWLT08
+eWI0ZjMxMCBQcm9kdWN0aW9uczE1MDMGA1UECwwsLT08eWI0ZjMxMCBQcm9kdWN0
+aW9ucyBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkxFjAUBgNVBAMMDS09PHliNGYzMTAg
+Q0ExJzAlBgkqhkiG9w0BCQEWGHRoZXVuaXMuYm90aGExQGdtYWlsLmNvbTAeFw0x
+ODA4MzExMDM2NThaFw00NjAxMTYxMDM2NThaMIHRMQswCQYDVQQGEwJERTEPMA0G
+A1UECAwGQmVybGluMR8wHQYDVQQKDBYtPTx5YjRmMzEwIFByb2R1Y3Rpb25zMUIw
+QAYDVQQLDDktPTx5YjRmMzEwIFByb2R1Y3Rpb25zIEludGVybWVkaWF0ZSBDZXJ0
+aWZpY2F0ZSBBdXRob3JpdHkxIzAhBgNVBAMMGi09PHliNGYzMTAgSW50ZXJtZWRp
+YXRlIENBMScwJQYJKoZIhvcNAQkBFhh0aGV1bmlzLmJvdGhhMUBnbWFpbC5jb20w
+ggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDVH4crWasYtZYjn0oueNpX
+pwLGJPyjngEQ8K9+pQU/nVUGWy/rKigyXuaqpllO4b7n5GYMHU9TQuVsEBVXMjXV
+FPxSqBUcupcXO5BoJT0XWG5scYnbOlJec9v3CbpEDdXyKjurCVTdO74gSTR8Fik4
+IywXjDe5Av1WvxY0XWQXNGy4rPUvLyDvtUn363Y4LMzDkPa2O3dCtfw96I9sCQr0
+BjpiAli8Ki63xmhh5i5/RnvfnrCpQq5fS1uKuPLnr/5YLJtJlR4O6HweNAdi5WIN
+LcJ18k2ZgntAh2Wy5gYiOVTS1Zq5UCeiFVa6wg8a9bqheLDhF/RFE5bRlxbJmZHL
+Po6FZRhUpFF08f5N0nWlk2StuQzHWivl+wh87+4MCUujbwpD2WB2b/emthTyr8sI
+vXKYegSrHQqsbd5V84SvQ9t1w7f+AxLTWNphIW6ii3gzGjgEP1ouE+oHwJknILEe
+eYjDAHQCkGHjXW8jVzijgf6ZK1lD/oaevM8tDP9mkD5ug+W8ndiWsl1G5esuanxw
+yLaR10aX+vtrx514Qi/cq522EeHP2f3FtgoVD0m2fuY4vcnorQZK2j5y6VmGpDD3
+3NcM0rUE7WlJAp6SVsLcqA3Vxoxjj6sx//vu4mhc9T9K12sV1I8iG3bEDovtD/Ml
+x0v+ywbcRg0b+ZhMe6ql3wIDAQABo2YwZDAdBgNVHQ4EFgQUttWevvVFFUh7CTY3
+uRVknRvxHy4wHwYDVR0jBBgwFoAUw1eTopvWmusz3AJiilVXD5TX61swEgYDVR0T
+AQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB
+AC1Fc8xEyDm3fJY3f0n7LO8GqooyC+CDH+GEzuEQ9jRGNaykxE1S40XHmbOGVD0m
+dBeYP+4+/qpbJMexQn6Zoh0zzuMfcfCj0K97GyJfavMRrRQO6eobew6SAx3NY8KZ
+jpzBOZ9q+AppWH6arY8Mh0rBy6ZdoY/fBkNrgb3MowsbXJP12HZS98ePGcAOOahN
+rTnpQnLT+AYLczcUy8xOt8v8ZdCLCudk8arbljqksjXaod8swNfEBnTjyFNjHhOu
+RVm6ElBLkoNd4QD4Wnltog773EyVl+v5wYmehrpDgQb/tDdhMRFnI9LGWywiRgfQ
+AGmyYu+A7oDTVPMjCmgV4sKyc2cgDlvTuPkVEFXj75vbAxoAGbrEzIsDrsktzhQ7
+3vQyCyx4FFspArTL+1JUFXpWt9DwQqzzZy09gEFL+HhjfXW+j6Sb3L7duLkq4RnL
+w1zoqmmqlbBnBwtecG23pbqdIXwXqZ1mIKQ6fdq6yf7UlKZCcH9cc2BFQuH9Xtk1
+1xv7eslBKT6wWCRNlhWZktMy9Cq1j4dvzLGOMbjScpabPf09J/N5kT1jxMi1UuCx
+uWpApC7Adp7knL6mC3jgipC1CVm1pvBz4rf1Bovnt5ZYnk2hLhL8gOboMuCSaGn2
+jFpF6SobC/zxBpNGf/agrZjpKRxS00+1AQhwZrD2GX1e
+-----END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIIGejCCBGKgAwIBAgIJAMdYdJsOwPOyMA0GCSqGSIb3DQEBCwUAMIHIMQswCQYD
+VQQGEwJERTEPMA0GA1UECAwGQmVybGluMQ8wDQYDVQQHDAZCZXJsaW4xHzAdBgNV
+BAoMFi09PHliNGYzMTAgUHJvZHVjdGlvbnMxNTAzBgNVBAsMLC09PHliNGYzMTAg
+UHJvZHVjdGlvbnMgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MRYwFAYDVQQDDA0tPTx5
+YjRmMzEwIENBMScwJQYJKoZIhvcNAQkBFhh0aGV1bmlzLmJvdGhhMUBnbWFpbC5j
+b20wIBcNMTgwODMxMTAyMzU3WhgPMjA3MzA2MDMxMDIzNTdaMIHIMQswCQYDVQQG
+EwJERTEPMA0GA1UECAwGQmVybGluMQ8wDQYDVQQHDAZCZXJsaW4xHzAdBgNVBAoM
+Fi09PHliNGYzMTAgUHJvZHVjdGlvbnMxNTAzBgNVBAsMLC09PHliNGYzMTAgUHJv
+ZHVjdGlvbnMgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MRYwFAYDVQQDDA0tPTx5YjRm
+MzEwIENBMScwJQYJKoZIhvcNAQkBFhh0aGV1bmlzLmJvdGhhMUBnbWFpbC5jb20w
+ggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCzkoLqhY+EH7y1s1ESD0hE
+CjxVvUBMKpzeUK0KPtMQpOOzAzVnwkQhqX8pcZyGms+EJEQVUvL9B+50u2OSW3Va
+mkkOVgWNV6irwuWdKwpLPxzh/4e5CA7IzZTv22yuZSZqvt7Xp8wcIZII8U3ZrfCm
+Zn3KIpli5uCK+z1uaQt/M6idttP9ZIlVXttNnhfs6oFsRpLVbx2aCuSd7kOoFgM6
+XKXcMq9XmyKr93D+/LP90StUkywGkOL4mrnDStF6gIjRLrQ3NhVtQx/5tWE655yJ
+L1qmZ34qgxcWwR1fnH8jvMnrlK4Cfykeqky0WdcpVjqQjwGPPCG+9LwuNLzr6WhS
+KUVDWDkktNBv8d+b52UzF0lZXxZOwrheqdQ5d39S+ETtLtJYFJQKFZvF+t1L469P
+5yIPPVsq2QYm5nEi8KgvGLREi0IZjECE0Ue9Y1H1AaT+jZ83vMy5plwFDYm5bNTv
+zjn3aHwna5t1k3x3CPBwAdmG1GtdW35OU7ulxLQ6h7+CfYGUKIfPcjob4rZC/xzh
+95gwYDizbhiV6iAhn2tIj3bMyMjNy/q+BO6RRn3hgEOq1Cbk1wW9GKtllB6gGaC7
+cxnfbqNPXzPS8ypaLrnnXd/Abm7Gji48bMvNtVRHI+EsmgbAGm9YeArb4hOIS4t2
+XOmqoNeG9DzY79b/xMCOeQIDAQABo2MwYTAdBgNVHQ4EFgQUw1eTopvWmusz3AJi
+ilVXD5TX61swHwYDVR0jBBgwFoAUw1eTopvWmusz3AJiilVXD5TX61swDwYDVR0T
+AQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIBAF+0
+nIyQfxGjlfmqx3sL4Wmedgk0gdHDRYYALaFT/JfWlFTKmb2fmFwhDarE1mHKxho4
+GqFZORoifS85mAqtFn8DhIXytkoJqYeGduif8vAXHUUrEvd/cP/ukc3PiHaGxF/g
+KOnodSXmlfxxqIqHWJsuAv6cW2+Q23FjFULEN4D+DeXJ4JmHuArGTzos1/Fo7Bx+
+fD76TYKMm6pc4bghIQ3vRLzzABJhgrprtIK1W74fJs7HAtORWM1b/8/VlQm/9jNX
+ig1tapctvZIcBM6R5PRO5YS/twr+DMJhkcwCMZ7T0QAHT5lzot1H+2PjDi/0Pm9O
+6ci4TC/1UvGL2DZCTcrn37BToij2yw0R2mKxKNkgM0fF9N5vt5Rh5Cil282Rq4h5
+Bx2m2ibXzdblYv1EDvrRBM+0AdNXOaTYl6gQ91lB3gVmZK7YEwRKwEgzLVMmYbcj
+7b3HfZa2NvqQ/TDcACCT3obKSODAkPQCRf1r66beGmyfdWw68K3fDMFL8peL5Ixn
+ITWQqorkeHfr20wSHZjElwmL1KhcosCENDffidnP4WieE8pdE1I8LhNPzkNt7/ns
+q1Hfrz8QQv6+a7nBfkudLKGPS22Fe1t5OlFNVzmb2hwshQrznKLBQeOZezAiRTXK
+bomtJsez2XuvqjNdcvt84v9ZbO4DzQVmo5RcO1qj
+-----END CERTIFICATE-----

cybafelo.local.cert.pem

@@ -0,0 +1,40 @@
+-----BEGIN CERTIFICATE-----
+MIIHBjCCBO6gAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwgdExCzAJBgNVBAYTAkRF
+MQ8wDQYDVQQIDAZCZXJsaW4xHzAdBgNVBAoMFi09PHliNGYzMTAgUHJvZHVjdGlv
+bnMxQjBABgNVBAsMOS09PHliNGYzMTAgUHJvZHVjdGlvbnMgSW50ZXJtZWRpYXRl
+IENlcnRpZmljYXRlIEF1dGhvcml0eTEjMCEGA1UEAwwaLT08eWI0ZjMxMCBJbnRl
+cm1lZGlhdGUgQ0ExJzAlBgkqhkiG9w0BCQEWGHRoZXVuaXMuYm90aGExQGdtYWls
+LmNvbTAeFw0xODA4MzExMDUzMjBaFw00NjAxMTUxMDUzMjBaMIHWMQswCQYDVQQG
+EwJERTEPMA0GA1UECAwGQmVybGluMQ8wDQYDVQQHDAZCZXJsaW4xHzAdBgNVBAoM
+Fi09PHliNGYzMTAgUHJvZHVjdGlvbnMxQjBABgNVBAsMOS09PHliNGYzMTAgUHJv
+ZHVjdGlvbnMgSW50ZXJtZWRpYXRlIENlcnRpZmljYXRlIEF1dGhvcml0eTEXMBUG
+A1UEAwwOY3liYWZlbG8ubG9jYWwxJzAlBgkqhkiG9w0BCQEWGHRoZXVuaXMuYm90
+aGExQGdtYWlsLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJyO
+WMJhgiVmsASlwOLjBmozZ+AcGQRfaFeCET7eIkml8QIIex9sADuoSTTEdL/5CFWl
+4lcbFFEXcLyP3ygfm252NnMYPGOkLGTq8Fr+O7LifAQRWdDI4yY5Qh9kHXi2hCSB
+ZLppydY1DYSRmUWnmoC2CCAjRdd1lu0f1Lquc3EYQ19chCrtJn8WUJF7xDezxs/O
+A+yOMzcSiMIIN5++davhhp7sDeM/vUO1EySfq2DYNmKDan7DYrW5t0wfjG2aFnUD
+E1pbH73VNqXZDZmWRlv2lkh/9oI14SCO4DiTSXdtP7nFc9fYNvDstKSlhEfIGY7Q
+id4y4WqvxNM9asqAv4cCAwEAAaOCAd8wggHbMAkGA1UdEwQCMAAwEQYJYIZIAYb4
+QgEBBAQDAgZAMDMGCWCGSAGG+EIBDQQmFiRPcGVuU1NMIEdlbmVyYXRlZCBTZXJ2
+ZXIgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFE0VqSzwDYcPEdOPuJydb1zolkaVMIH2
+BgNVHSMEge4wgeuAFLbVnr71RRVIewk2N7kVZJ0b8R8uoYHOpIHLMIHIMQswCQYD
+VQQGEwJERTEPMA0GA1UECAwGQmVybGluMQ8wDQYDVQQHDAZCZXJsaW4xHzAdBgNV
+BAoMFi09PHliNGYzMTAgUHJvZHVjdGlvbnMxNTAzBgNVBAsMLC09PHliNGYzMTAg
+UHJvZHVjdGlvbnMgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MRYwFAYDVQQDDA0tPTx5
+YjRmMzEwIENBMScwJQYJKoZIhvcNAQkBFhh0aGV1bmlzLmJvdGhhMUBnbWFpbC5j
+b22CAhAAMA4GA1UdDwEB/wQEAwIFoDATBgNVHSUEDDAKBggrBgEFBQcDATBJBgNV
+HREEQjBAghAqLmN5YmFmZWxvLmxvY2Fsgg4qLmN5YmFmZWxvLmRldoIOY3liYWZl
+bG8ubG9jYWyCDGN5YmFmZWxvLmRldjANBgkqhkiG9w0BAQsFAAOCAgEAFIpo6/xp
+3lRwYDtMXVq7tc4Uv2oNTCCxF8upi6UZVi91GWmHFcSb0c2nWiiy6UV5OL7ldUtP
+p2DcEr8wKLfHBmwwI0JMBfsWYVBGvhoF/4BJayCdTc/x3wTc/I99sdaQDPcJBIEe
+O0qnH+XFy6hN/1jwPbE643HEfYoAQWrxO3isOaIEm3QipxZF9tyrS7B+Y4GFfijE
+UGM3Z2WXIwn1uiCXaQUmv6qINzIm9P/E0TAlIWlIdN2n00Grx15gTsjcJZnlEogc
+48dwL8WjQ6CvOczvaBIZyrow7u21QYPzVINOTWh+m1omxqLU3n2uOJc3Kkh75HPk
+aB2xDEjtXKwaP+Y/oFuV+qjW/4bOFzKCqp72Xtkqom7tTDV6J8cyg9FirQkiGLg0
+rXWEf/dj5EIbnY8HYvFBoaqkPqpZ6Hwj74BlfqPLFbUFsFkZvjOYwTuSjDzwchcF
+r/Z8GpXVvC/+i16GNv4N4x/Vnx+QFBDprS9weMEnGtRV3dVhM52jXQtBCBD5HvIp
+yo9uJcfhCmUF1zMNOOCckOESMOeMFqYufS3s4kT3hykRrGmlVI5qW9W59O2Sw0jq
+OULAU7HqlST2g+CtcV6Zkh2Qdm2QEJdQA7jEQxoWx0F8ERG2vI7KvWERkAIWLefF
+9+dn/0XHV2o+ZWKQXBou3jbAA1OIjP0/1KM=
+-----END CERTIFICATE-----

cybafelo.local.key.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAnI5YwmGCJWawBKXA4uMGajNn4BwZBF9oV4IRPt4iSaXxAgh7
+H2wAO6hJNMR0v/kIVaXiVxsUURdwvI/fKB+bbnY2cxg8Y6QsZOrwWv47suJ8BBFZ
+0MjjJjlCH2QdeLaEJIFkumnJ1jUNhJGZRaeagLYIICNF13WW7R/Uuq5zcRhDX1yE
+Ku0mfxZQkXvEN7PGz84D7I4zNxKIwgg3n751q+GGnuwN4z+9Q7UTJJ+rYNg2YoNq
+fsNitbm3TB+MbZoWdQMTWlsfvdU2pdkNmZZGW/aWSH/2gjXhII7gOJNJd20/ucVz
+19g28Oy0pKWER8gZjtCJ3jLhaq/E0z1qyoC/hwIDAQABAoIBAQCN4HKPtc48FtNt
+Yslq1FL765o3fz8st0nYBAec8bIhDEFdllH+J+IOLnQpXeBwGT90XuDAD8pZsuR3
+/eo+cmZptLejllMj+aRB0KgBzmRLuPSquw6qJ2OzQDCsQg5zVvRqINkoFrbTaUDW
+4xwEA+AAxPaYKV8h427jdfVTOMVltyxw2rpzfEx9C1ENCeMqbEB4cQ6Hw9w1HONw
+2E1IP/nmCTHMCm9WLRDJxNhBNEBxAhzSA7JDxsN7eYUYKnH8y+uRwl5DU/62qxCe
+Pyu6Y68Wty8IK45s11LlKdeC/1g4sYg9RYpM5+E5w8BM/2wS80fHPWoBct3hmm9P
+4xbeKwABAoGBAMtg5ypF5EMDbIuKSN21G91zxP5LkyA3Uby06jW+C1cQmoKkTY1d
+F+Nru2swuck0HYZloS9jVWuXkAqI1PPfnlE/jjYMp6poposTu8cETeQcag84K1Rx
+EbFobW72D4UX7VZ5b9vSdsxYYTUe0mhDF6hO0maZ6PlNNMvvuPrNMxNBAoGBAMUQ
+FSob+JzkHL5NbXOGqjWdehhrG78q0T4y7b1T2XSC/PtV8huxnpRdrNHbkXZti7s2
+H3Qtqp+o7zCMdz3nGI/W6eYbRwkmGw12Lynr1kYiax+eSPMQs+ljuxynGxkY1kB/
+cobWiyYJfS3LnnMcjdgrjnorD5CUIlj7cCHqQsjHAoGAV+WVgquaL2w3aUdmnos7
+c8YpCU5YU8AUz13RK1DrTcGbRYMFEWd+f4d8BKOWZ+LiL8eUlgp0TH/AfQ0OHCg1
+ICA7shheDkQUVl889JJjp4awP8uizmffobDkOuSVaIwiwxDQy0x2k3JO8MpVXUJB
+4zfNrxItojE/9DOy2pH81QECgYB9yM45mrEOM+zE69c5LnPm1SXiADwtwb7d3NQz
+TRo4bIPeSfXIB5AZU9HEAkrPNQ1D6kAZgCywzLwgWQij0qay6ZNS9YZaKKCL7ywb
+rhWPntiRzg7yV27/QlFk8KUzV88qTC9mMfuPw+7LFHWHNGq12NeQ03uT5XonIhdp
+DoaicQKBgA6qUiwCxdsTA6pvQu4JuT8Xs//TlvekI/apRimT+MCPsgSKt9kVYTCW
+kggFDYz2P8rIQ+qLRCpdY9JSY6rImjgY2IFWKRzIcLsN8xIoxYM+Ipm53ZQ3Pdw3
+1AV9eVY6z+TNaG326nhzvlEEDcRpEpW4FqUPDODogKyn5rkrMfJX
+-----END RSA PRIVATE KEY-----

hosts

@@ -12,4 +12,4 @@
 127.0.1.1   dev-r3-3ditor.cybafelo.local
 127.0.1.1   dev-r3-portal.cybafelo.local
 127.0.1.1   dev-r3-api.cybafelo.local
-127.0.1.1   dev-ar.cybafelo.local
+127.0.1.1   dev-r3-websocket.cybafelo.local