Skip to content

Update installation docs #903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asbiin merged 4 commits into from
Feb 17, 2018
Merged

Update installation docs #903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
331356a
Update documentation
asbiin Feb 16, 2018
0c77eab
Update
asbiin Feb 16, 2018
8d21d10
Merge remote-tracking branch 'origin/master' into update-installation…
asbiin Feb 16, 2018
67a8a62
composer install with --no-dev
asbiin Feb 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ docker_push_bintray:
build: build-dev

build-prod:
composer install --no-interaction --prefer-dist --no-suggest --no-dev
composer install --no-interaction --prefer-dist --no-suggest --optimize-autoloader --no-dev
npm install
npm run production

build-dev:
composer install --no-interaction --prefer-dist --no-suggest
composer install --no-interaction --prefer-dist --no-suggest --optimize-autoloader
npm install
npm run dev

Expand Down
5 changes: 3 additions & 2 deletions docs/contribute/contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ We've installed the development version with [Valet](https://laravel.com/docs/va
* [Node](https://nodejs.org/en/)
* PHP 7.0+
* [Composer](https://getcomposer.org/)
* GNU Make

**Steps to install Monica**

Expand All @@ -81,7 +82,7 @@ Once the above softwares are installed (or if you've finished the installation o
1. If you use Homestead (which uses Vagrant under the hood), `vagrant ssh` will let you login as root inside your VM.
1. Run `make install` in the folder the repository has been cloned. This will run :
1. `cp .env.example .env` to create your own version of all the environment variables needed for the project to work.
1. `composer install` to install all packages.
1. `composer install --no-interaction --prefer-dist --no-suggest --optimize-autoloader` to install all packages.
1. `npm install` to install all the front-end dependencies and tools needed to compile assets.
1. `npm run dev` to compile js and css assets.
1. `php artisan key:generate` to generate an application key. This will set `APP_KEY` with the right value automatically.
Expand All @@ -97,7 +98,7 @@ If you haven't skipped the seeding of fake data, two accounts are created by def
* Second account is `[email protected]` with the password `blank`. This account does not contain any data and shall be used to check all the blank states.

To update a current installation with the latest dependencies, just run `make update` to run
1. `composer install`
1. `composer install --no-interaction --prefer-dist --no-suggest --optimize-autoloader`
1. `npm install`
1. `npm run dev`
1. `php artisan migrate`
Expand Down
219 changes: 52 additions & 167 deletions docs/installation/debian.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,241 +9,126 @@ sudo apt install apache2 mariadb-server php7.0 php7.0-mysql php7.0-xml \

#### 2. Clone the repository

```
You may install Monica by simply closing the repository. Consider cloning the repository into any folder, example here in `/var/www/monica` directory:
```sh
sudo git clone https://github.com/monicahq/monica.git /var/www/monica
```

You should check out a tagged version of Monica since `master` branch may not always be stable.
Find the latest official version on the [release page](https://github.com/monicahq/monica/releases)
```sh
cd /var/www/monica
# Clone the desired version
sudo git checkout tags/v1.6.2
```

#### 3. Change permissions on the new folder

```
```sh
sudo chown -R www-data:www-data /var/www/monica
```

#### 4. Install nodejs (this is needed for npm)

```
curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
```
```
sudo apt-get install -y nodejs
```sh
curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
sudo apt install -y nodejs
```

#### 5. Install composer

Download and install the binary by following the [Command-line installation of composer](https://getcomposer.org/download/).

Move it to the bin directory.
```
```sh
sudo mv composer.phar /usr/local/bin/composer
```

#### 6. Setup the database

First we're making the database a bit more secure.
```
First make the database a bit more secure.
```sh
sudo mysql_secure_installation
```

Next log in with the root account to configure the database.
```
```sh
sudo mysql -uroot -p
```

This command creates a database called monicadb
Create a database called 'monica'.
```sql
CREATE DATABASE monica;
```
create database monicadb;
```

while this commands creates a database user called monica and its
password 'strongpassword'.

```
Create a user called 'monica' and its password 'strongpassword'.
```sql
CREATE USER 'monica'@'localhost' IDENTIFIED BY 'strongpassword';
```

We have to authorize the new user on the monicadb so that he is allowed to
change the database.

```
GRANT ALL ON monicadb.* TO 'monica'@'localhost';
We have to authorize the new user on the `monica` db so that he is allowed to change the database.
```sql
GRANT ALL ON monica.* TO 'monica'@'localhost';
```

And finally we apply the changes and exit the database.
```
```sql
FLUSH PRIVILEGES;
exit
```

#### 7. Configure Monica

Run `composer install` in the folder the repository has been cloned to. Which in our case would be /var/www/monica.

Create a copy of the example configuration file `cp .env.example .env`.

Now update `.env` with your specific needs. If you would run the setup with the exact commands used above your file should look like this:

```
# Two choices: local|production. Use local if you want to install Monica as a
# development version. Use production otherwise.
APP_ENV=local

# true if you want to show debug information on errors. For production, put this
# to false.
APP_DEBUG=false

# The encryption key. This is the most important part of the application. Keep
# this secure otherwise, everyone will be able to access your application.
# Must be 32 characters long exactly.
# Use `php artisan key:generate` to generate a random key.
APP_KEY=ChangeMeBy32KeyLengthOrGenerated

# The URL of your application.
APP_URL=http://localhost

# Database information
# To keep this information secure, we urge you to change the default password
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=monica
DB_USERNAME=homestead
DB_PASSWORD=secret
DB_TEST_DATABASE=monica_test
DB_TEST_USERNAME=homestead
DB_TEST_PASSWORD=secret

# Mail credentials used to send emails from the application.
MAIL_DRIVER=smtp
MAIL_HOST=mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=ValidEmailAddress
MAIL_FROM_NAME="Some Name"
APP_EMAIL_NEW_USERS_NOTIFICATION=EmailThatWillSendNotificationsForNewUser

# Default timezone for new users. Users can change this setting inside the
# application at their leisure.
# Must be exactly one of the timezones used in this list:
# https://github.com/monicahq/monica/blob/master/resources/views/settings/index.blade.php#L70
APP_DEFAULT_TIMEZONE=US/Eastern

# Ability to disable signups on your instance.
# Can be true or false. Default to false.
APP_DISABLE_SIGNUP=true

# Frequency of creation of new log files. Logs are written when an error occurs.
# Possible values: single|daily|syslog|errorlog
APP_LOG=daily

# Specific to the hosted version on .com. You probably don't need those.
# Let them empty if you don't need them.
GOOGLE_ANALYTICS_APP_ID=
INTERCOM_APP_ID=

# Error tracking. Specific to hosted version on .com. You probably don't need
# those.
SENTRY_SUPPORT=false
SENTRY_DSN=

# Send a daily ping to https://version.monicahq.com to check if a new version
# is available. When a new version is detected, you will have a message in the
# UI, as well as the release notes for the new changes. Can be true or false.
# Default to true.
CHECK_VERSION=true

# Have access to paid features available on https://monicahq.com, for free.
# Can be true or false. Default to false.
# If set to true, that means your users will have to pay to access the paid
# features. We use Stripe to do this.
REQUIRES_SUBSCRIPTION=false

# ONLY NECESSARY IF MONICA REQUIRES A SUBSCRIPTION TO WORK
# Leave blank unless you know what you are doing.
STRIPE_KEY=
STRIPE_SECRET=
paid_plan_monthly_friendly_name=
paid_plan_monthly_id=
paid_plan_monthly_price=

# Change this only if you know what you are doing
CACHE_DRIVER=database
SESSION_DRIVER=file
QUEUE_DRIVER=sync

# Default filesystem to store uploaded files.
# Possible values: public|s3
DEFAULT_FILESYSTEM=public

# AWS keys for S3 when using this storage method
AWS_KEY=
AWS_SECRET=
AWS_REGION=us-east-1
AWS_BUCKET=
AWS_SERVER=
```

Then run the following instructions:
* Run `php artisan key:generate` to generate an application key. This will set `APP_KEY` with the right value automatically.
* Open the file `.env` to set the different variables needed by the project. The file comes with predefined values - you won't have to change most of them.
* Run `php artisan setup:production` to run the migrations, seed the database and symlink folders.
* Optional: run `php artisan passport:install` to generate the secure asset tokens required for the API. If you don't plan to use the API, don't do this step.
`cd /var/www/monica` then run these steps with `sudo`:

1. `cp .env.example .env` to create your own version of all the environment variables needed for the project to work.
1. Update `.env` to your specific needs. Don't forget to set `DB_USERNAME` and `DB_PASSWORD` with the settings used behind.
1. Run `composer install --no-interaction --prefer-dist --no-suggest --optimize-autoloader --no-dev --ignore-platform-reqs` to install all packages.
1. Run `npm install` to install all the front-end dependencies and tools needed to compile assets.
1. Run `npm run production` to compile js and css assets.
1. Run `php artisan key:generate` to generate an application key. This will set `APP_KEY` with the right value automatically.
1. Run `php artisan setup:production` to run the migrations, seed the database and symlink folders.
1. Optional: run `php artisan passport:install` to create the access tokens required for the API (Optional).

#### 8. Configure cron job

As recommended by the generic installation instructions we create a cronjob which runs `artisan schedule:run` every minute.

For this execute this command:
```
```sh
sudo crontab -e
```

And then add this line to the bottom of the window that opens.

```
* * * * * sudo -u www-data php /var/www/html/artisan schedule:run
* * * * * sudo -u www-data php /var/www/monica/artisan schedule:run
```

#### 9. Configure Apache webserver

We need to enable the rewrite module of the Apache webserver:

```
```sh
sudo a2enmod rewrite
```

Now look for this section in the `/etc/apache2/apache2.conf` file.
Edit `/etc/apache2/sites-enabled/000-default.conf` file.

* Update `DocumentRoot` property to:
```
<Directory /var/www>
Options Indexes FollowSymLinks
AllowOverride None
Require all granted
</Directory>
DocumentRoot /var/www/monica/public
```

and change it to:

* and add a new `Directory` directive:
```
<Directory /var/www/monica>
Options Indexes FollowSymLinks
AllowOverride All
Require all granted
<Directory /var/www/monica/public>
Options Indexes FollowSymLinks
AllowOverride All
Require all granted
</Directory>
```

Save the apache2.conf file and open `/etc/apache2/sites-enabled/000-default.conf` and look for this line:

```
DocumentRoot /var/www/html
```
and change it to:
```
DocumentRoot /var/www/monica/public
Finally restart Apache.
```sh
sudo systemctl restart apache2
```

After you save the 000-default.conf file you can finally restart Apache and are up and running.
```
sudo service apache2 restart
```
Monica will be up and running to `http://localhost`.
Loading