muonium / server

Muonium's server API

Requirements

• MySQL/MariaDB
• Redis
• Composer
• HTTPD Apache, 2.4 preferred
• PHP 5.6 / 7.0+
• PHP mcrypt and curl extensions

License

Read the license please : here

Feel free to contribute :)

Artworks: license is this one.

Security

If you are a security expert, you can help us to build more securely Muonium. Or, if you see a security issue or several in the code, do not hesitate to contribute.

Cryptography

Take a look at our cryptography details.

Installation

Follow these steps to install Muonium's server API.

1. git clone https://github.com/muonium/server.git at the root of your configuration and create a folder called nova at the same level with server.git

--root

----/server

----/nova

2. run this command inside server folder in order to install dependencies.

php composer.phar install

3. create a database named "cloud"
4. create an user for the "cloud" database, give it all the privileges, and exec cloud.sql in the "cloud" db.
5. create server/config/confDB.php and configure it like in confDB.php.model:

<?php
namespace config;
class confDB {
	const host = "a.b.c.d"; //the ip of the database server, can be localhost/127.0.0.1
	const user = "user"; //mysql user who has the privileges on the DB "cloud"
	const password = "password"; //its password
	const db = "cloud"; //the DB
}
?>

6. Do the same for server/config/confMail.php, for server/config/confPayments.php, for server/config/confRedis.php and for server/config/secretKey.php

7. Create a folder public, clone the translations, extract the webclient folder to public and rename it as translations.

PS: enable mod_rewrite and mod_headers

Documentation

You can find our documentation here.

Contributing

Take a look at CODE_OF_CONDUCT.md and CONTRIBUTING.md.