Skip to content

Commit

Permalink
Move set up instructions mostly into the main manual.
Browse files Browse the repository at this point in the history
  • Loading branch information
ari committed Oct 8, 2021
1 parent 65acc5f commit 5456af7
Showing 1 changed file with 20 additions and 44 deletions.
64 changes: 20 additions & 44 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,20 @@
## How to run angel server

1. Install mariadb.
<ul>
<li>If you are a macOS user, first you should install homebrew:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
and then run

brew install mariadb
For the moment of this doc writing homebrew installs 10.6.4 mariadb version by default.<br></li>
<li>Run <code>brew services start mariadb</code> to start server.</li>
<li>Run <code>mysql_secure_installation</code> and configure root account.</li>
<li>Run <code>mariadb -uroot -p[root password, if you changed it]</code> to launch mariadb, then enter next commands to create new user with root privileges:

CREATE USER 'onCourse' IDENTIFIED BY 'password';
GRANT ALL PRIVILEGES ON * . * TO 'onCourse';
FLUSH PRIVILEGES;

</li>
<li>Create database: run<br>

CREATE DATABASE angel_db;
exit;

</li>
</ul>
2. Install Java 11. Run
<code>brew cask install java11</code>
3. Setup onCourse.yml.<br>
<ul>
<li>Copy file <code>onCourse.yml</code> from <code>server/src/packaging/onCourse.yml</code> to <code>server</code> directory.<br>
<li>Configure smtp. Change <code>[[email protected]]</code> with your email and <code>[your_email_password]</code> with password to your email account. Follow <a href="https://support.google.com/mail/answer/7126229?hl=en">Google documentation</a> to configure smtp for your email address.
</ul>
4. Create and put near configured <code>onCourse.yml</code> file <code>createAdminUsers.txt</code>, that must have lines in the same format: <code>[firstname] [lastname] [your email]</code> like <code>Peter Peterson [email protected]</code> of new system user, which will be added to database. After first running of the server you will receive on selected email letter with credentials to the system.
5. Make sure, that access to accout with entered email is allowed from unsafe applications. Go to <a href="https://myaccount.google.com/lesssecureapps">Google profile settings</a>, select account you want to share and switch "unsafe application
locked". When you receive message from server on your email you may lock this ability again.
6. Build project with command <code>./gradlew -x test server:build</code> executed from root folder.
7. If you use Intellij Idea, create Application configuration, set main class <code>server/src/main/java/ish/oncourse/server/AngelServer.java</code>, module <code>onCourse.server.main</code> and working directory as <code>server</code>.
Then run configuration.<br>
Else run task <code> ./gradlew -x test server:runServer</code> from root directory.
8. Check email. Assign link from email message.

If you have any error, you know how to avoid any error, or you want to improve any point, contact [email protected]. Your improvements may help next developers.
## Install and configure onCourse

Instructions can be found [here](https://www.ish.com.au/onCourse/doc/manual/#install).


## Running from source

Rather than downloading onCourse from releases, you can run it from checked out source.

./gradlew -x test server:runServer


If you use Intellij you'll find that the project already has an .idea folder with most of the configuration already there. Don't import the project, just file->open from inside Intellij.

To run the project from Intellij, Run-> Edit configurations. Create a new configuration and set the main class to `server/src/main/java/ish/oncourse/server/AngelServer.java`, module `onCourse.server.main` and working directory as `server`.


## Help

Post in our [forums](https://oncourse.discourse.group/) with any questions or suggestions.

0 comments on commit 5456af7

Please sign in to comment.