gosora/docs/installation.md

# Windows Installation

Run `install.bat`, e.g. double-click on it. You will also have to start-up MySQL, which if you're using Wnmp or friends is just a matter of opening that program and starting the MySQL process via it.

Follow the instructions shown on the screen.

To navigate to the folder the software is in at any time in the future, you can just type `cd` followed by the folder's name, e.g. `cd /home/gosora/src/` and then you can run your commands. cd stands for change directory.


# Linux Simple Installation

Simple installations are usually recommended for trying out the software rather than for deploying it in production as they're less hardened and have fewer service facilities.

This might also be fine, if you're using something else as a reverse-proxy (e.g. Nginx or Apache).

First, we need somewhere for the software to live, if you're familiar with Linux, then you might have some ideas of your own, otherwise we may just go for `~/gosora`.

First, we'll navigate to our home folder by typing: `cd ~`

And then, we'll going to pull a copy of Gosora off the git server with: `git clone https://github.com/Azareal/Gosora gosora`

We can now hop into the newly created folder with the same command we used for getting to the home folder:

`cd gosora`

And now, we'll change the permissions on the installer script, otherwise we'll get an access denied error:

`chmod 755 ./update-deps-linux`

`chmod 755 ./install-linux`

Just run this to run the installer:

`./install-linux`

Follow the instructions shown on the screen.


# Linux Installation with Systemd Service

You will need administrator privileges on the machine (aka root) to add a service.

First, you will need to jump to the place where you want to put the code, we will use `/home/gosora/src/` here, but if you want to use something else, you'll have to modify the service file with your own path (but *never* in a folder where the files are automatically served by a webserver).

If you place it in `/www/`, `/public_html/` or any similar folder, there's a chance that your server might be compromised.

The following commands will pull the latest copy of Gosora off the Git repository, will create a user account to run Gosora as, will set it as the owner of the files and will start the installation process.

If you're casually setting up an installation on your own machine which isn't exposed to the internet just to try out Gosora, you might not need to setup a seperate account for it or do `chmod 2775 logs`.

Please type the following commands into the console and hit enter:

`cd /home/`

`useradd gosora`

`passwd gosora`

Type in a strong password for the `gosora` user, please oh please... Don't use "password", just... don't, okay? Also, you might want to note this down somewhere.

```bash
mkdir gosora

cd gosora

git clone https://github.com/Azareal/Gosora src

chown -R gosora ../gosora

chgrp -R www-data ../gosora

cd src

chmod 2775 logs

chmod 2775 attachs

chmod 2775 uploads

chmod 2775 tmp

chmod 755 ./update-deps-linux

chmod 755 ./install-linux

./install-linux
```

Follow the instructions shown on the screen.

We will also want to setup a service:

`chmod 755 ./pre-run-linux`

`cp ./gosora_example.service /lib/systemd/system/gosora.service`

`systemctl daemon-reload`


# Additional Configuration

For things like HTTPS, you might also need to [modify your config.json](https://github.com/Azareal/Gosora/blob/master/docs/configuration.md) file after installing Gosora to get it working.

You can get a free private key and certificate pair from Let's Encrypt or Cloudflare.

If you're using Nginx or something else as a reverse-proxy in-front of Gosora, you will have to consult their documentation for advice on setting HTTPS. You may also need to enable LoosePort and LooseHost in `config/config.json`.

If you're behind a reverse-proxy that terminates the SSL / TLS connection, you may want to set the SslSchema config setting to true in `config/config.json` and leave EnableSsl disabled. An example of this is if the certificate is setup on the reverse-proxy rather than the instance.


For email, you will need a SMTP server (either provided by yourself or by a transactional mail provider who specialises in doing so).
You can setup it up via config.json with the Email setting and the ones starting with SMTP.

It is possible to send emails without SMTP with the experimental sendmail plugin, however there is a high chance of your emails ending up in the user's spam folder, if it arrives at all.

You may need to open a port in your firewall in order for the outside world to see your instance of Gosora.


# Advanced Installation

This section explains how to set things up without running the batch or shell files. For Windows, you will likely have to open up cmd.exe (the app called Command Prompt in Win10) to run these commands inside or something similar, while with Linux you would likely use the Terminal or console.

For more info, you might want to take a gander inside the `./run-linux` and `./install-linux` shell files to see how they're implemented.

Linux:

```bash
git clone https://github.com/Azareal/Gosora gosora

cd gosora

go get -u github.com/mailru/easyjson/...

easyjson -pkg common

go get

rm -f tmpl_*.go

rm -f gen_*.go

rm -f tmpl_client/tmpl_*.go

rm -f ./Gosora

rm -f ./common/gen_extend.go

go generate

go build -ldflags="-s -w" -o RouterGen "./router_gen"

./RouterGen

go build -ldflags="-s -w" -o HookStubGen "./cmd/hook_stub_gen"

./HookStubGen

go build -ldflags="-s -w" -o HookGen "./cmd/hook_gen"

./HookGen

go build -ldflags="-s -w" -o QGen "./cmd/query_gen"

./QGen

go build -ldflags="-s -w" -o Gosora

go build -ldflags="-s -w" -o Install "./cmd/install"

./Install

go get -u github.com/mailru/easyjson/...

easyjson -pkg common

./Gosora -build-templates

./Gosora
```

Windows:

```batch
git clone https://github.com/Azareal/Gosora gosora

cd gosora

go get -u github.com/mailru/easyjson/...

easyjson -pkg common

go get

del "template_*.go"

del "tmpl_*.go"

del "gen_*.go"

del ".\tmpl_client\template_*"

del ".\tmpl_client\tmpl_*"

del ".\common\gen_extend.go"

del "gosora.exe"

go generate

go build -ldflags="-s -w" "./router_gen"

router_gen.exe

go build -ldflags="-s -w" "./cmd/hook_stub_gen"

hook_stub_gen.exe

go build -ldflags="-s -w" "./cmd/hook_gen"

hook_gen.exe

easyjson -pkg common

go build -ldflags="-s -w" "./cmd/query_gen"

query_gen.exe

go build -ldflags="-s -w" -o gosora.exe

go build -ldflags="-s -w" "./cmd/install"

install.exe

gosora.exe -build-templates

gosora.exe
```

I'm looking into minimising the number of go gets for the advanced build and to maybe remove the platform and database engine specific dependencies if possible for those who don't need them.

If systemd gives you no permission errors, then make sure you `chown`, `chgrp` and `chmod` the files and folders appropriately.

You don't need `-ldflags="-s -w"` in any of the commands, however it will make compilation times faster.

Building and running HookGen is optional, but strips unneccesary hook indirects for plugins you don't use.