Skip to content
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.

Install instruc #79

Closed
wants to merge 3 commits into from
Closed

Install instruc #79

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c55cae0
update README.md with install instructions for Linux
FoxyHawk Feb 1, 2019
e3a18fe
rectify little mistakes
FoxyHawk Feb 1, 2019
481b562
Remove deploy part in README and ./deploy folder following superboum'…
AntoineBvn Apr 10, 2019
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
106 changes: 86 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,92 @@
insalan.fr
==========
# insalan.fr

[![Build Status](https://travis-ci.org/InsaLan/insalan.fr.svg?branch=master)](https://travis-ci.org/InsaLan/insalan.fr)
[![Maintainability](https://api.codeclimate.com/v1/badges/68707ca6cd1a2b332dc4/maintainability)](https://codeclimate.com/github/InsaLan/insalan.fr/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/68707ca6cd1a2b332dc4/test_coverage)](https://codeclimate.com/github/InsaLan/insalan.fr/test_coverage)

Website to handle esport tournament

Installation
------------

Download vendors
Considering you have composer.phar installed and in your PATH :
## Installation

The project need the following package and php-extension :

Package | Comment
------- | -------
git |
php | php7.0
composer |
mariadb-server | if use with local database
zip | not necessary (only for unzip during install)

PHP extension | Comment
------------- | -------
php-curl |
php-intl | date translation
php-mbstring | doctrine:create:schema:create
php-mysql |
php-xml |


### Linux


#### Base packages

Update your local packages

```bash
sudo apt-get update && apt-get upgrade
```

Install git and clone the repository

```bash
sudo apt-get install git
git clone https://github.com/InsaLan/insalan.fr
```

It is recommended to get `composer.phar` in your PATH : https://getcomposer.org/doc/00-intro.md

Install the remaining packages

```bash
sudo apt-get install php php-curl php-intl php-mbstring php-mysql php-xml mariadb-server zip
```

Proceed with the install and accept default settings

```bash
cd insalan.fr
composer.phar install
```

If not set with composer.phar, configure symfony2 :
At this point, you should be able to run the web server but any pages you try to access will return an error since the database is not setup.


#### mariadb

Log in mariadb as root

```bash
cp app/config/parameters.yml.dist app/config/parameters.yml
vim app/config/parameters.yml
sudo mysql -u root -p
```

Create database, user and grant access

```mariadb
CREATE DATABASE insalan;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you create database by this way, instead of using php app/console doctrine:database:create as we did before ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script was not able to connect to mariaDB since there was not a user 'insalan' in the database. Maybe because I was not logging in as 'insalan' on my test system.

I could try this week end or the next one (exams next week...)

CREATE USER insalan@'localhost';
GRANT ALL PRIVILEGES ON insalan.* to insalan@'localhost';
```

Create database & load fixtures (php-mbstring needed)

#### Fill database and run

Load fixtures (php-mbstring needed)

```bash
php app/console doctrine:database:create
php app/console doctrine:schema:create
php app/console doctrine:schema:create #have to be killed manually
php app/console doctrine:fixtures:load
```

Expand All @@ -50,17 +108,23 @@ Launch development server

```bash
php app/console server:run #localhost only
php app/console server:run 0.0.0.0:9001 #available for everyone
php app/console server:run 0.0.0.0 #available for everyone on port 8000
```
(you can also use the php builtin development web server : `cd web && php -S localhost:9001`)
(you can also use the php builtin development web server : `cd web && php -S localhost:8000`)


### Windows

Deploy on shared web hosting services
-------------------------------------
TODO
http://www.wampserver.com/ should be able to provide everything you need.


## Deploy on shared web hosting services
Copy link
Member

@superboum superboum Feb 2, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if it makes sense to keep this part. It has been written at a time where our website was hosted on an OVH PHP hosting where we didn't have any access to a shell.
So it was really hard to deploy Symfony on this platform and I put my hacks in these scripts to "ease" the deployment.
Finally, we moved to a VPS for performance and simplicity reasons.
If you don't use them, I am really encouraging you to:

  1. Remove this part of the documentation
  2. Remove the ./deploy folder

In any case, I must warn you that even 4 years ago these scripts were not reliable to deploy.
And I think that today it can be only worse.

At least, if you are very nostalgic and want to keep these instructions+scripts, put an enormous disclaimer saying that this method is broken

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, thank you for your advice. We will remove that part.


You can use the deploy-ftp script to deploy on a mutualised website.
You must also have ncftp on your client (yum install ncftp/apt-get install ncftp)

1) Configure your deployment
### 1) Configure your deployment

```bash
cd deploy/conf
Expand All @@ -78,7 +142,7 @@ cp parameters.yml.dist parameters.yml
vim parameters.yml
```

2) Deploy
### 2) Deploy

Deploy takes approximately 5 minutes.

Expand All @@ -87,11 +151,13 @@ cd deploy
./deploy-ftp.sh
```

3) Remove app/cache/prod content
### 3) Remove app/cache/prod content

Use filezilla to clear cache, ie remove app/cache/prod folder content

Backup DB before deploy, update it locally and send it after deploy if you changed the schema.

4) Contributing file

## Contributing

If you wish to contribute to the insalan.fr project, refer to [this](https://github.com/insalan/insalan.fr/blob/master/CONTRIBUTING.md) file.