README
This commit is contained in:
parent
1b961403ad
commit
2f65088c5e
38
README.md
38
README.md
|
@ -13,23 +13,15 @@ Table of Contents
|
||||||
* [Create a new gist](#create-a-new-gist)
|
* [Create a new gist](#create-a-new-gist)
|
||||||
* [Update an existing Gist](#update-an-existing-gist)
|
* [Update an existing Gist](#update-an-existing-gist)
|
||||||
* [Console](#console)
|
* [Console](#console)
|
||||||
* [Create and update gists:](#create-and-update-gists)
|
* [Create and update gists](#create-and-update-gists)
|
||||||
* [Create user](#create-user)
|
* [Create user](#create-user)
|
||||||
* [Show stats](#show-stats)
|
* [Show stats](#show-stats)
|
||||||
* [Configuration](#configuration)
|
* [Configuration](#configuration)
|
||||||
* [API](#api-1)
|
* [API](#api-1)
|
||||||
* [Personal instance](#personal-instance)
|
|
||||||
* [Authentication](#authentication)
|
* [Authentication](#authentication)
|
||||||
* [Disabling login](#disabling-login)
|
|
||||||
* [Disabling registration](#disabling-registration)
|
|
||||||
* [Force registration/login](#force-registrationlogin)
|
|
||||||
* [Login required to edit a gist](#login-required-to-edit-a-gist)
|
|
||||||
* [Login required to view a gist](#login-required-to-view-a-gist)
|
|
||||||
* [Login required to view an embeded gist](#login-required-to-view-an-embeded-gist)
|
|
||||||
* [Debug](#debug)
|
* [Debug](#debug)
|
||||||
* [Deployment](#deployment)
|
* [Deployment](#deployment)
|
||||||
|
|
||||||
|
|
||||||
GIST
|
GIST
|
||||||
====
|
====
|
||||||
|
|
||||||
|
@ -110,9 +102,6 @@ Edit `propel.yaml`. **Use spaces instead of tabulations**.
|
||||||
|
|
||||||
[...]
|
[...]
|
||||||
|
|
||||||
Then `$ make propel`.
|
|
||||||
|
|
||||||
|
|
||||||
**SQLITE**
|
**SQLITE**
|
||||||
|
|
||||||
propel:
|
propel:
|
||||||
|
@ -212,7 +201,7 @@ Params:
|
||||||
Console
|
Console
|
||||||
-------
|
-------
|
||||||
|
|
||||||
### Create and update gists:
|
### Create and update gists
|
||||||
|
|
||||||
```
|
```
|
||||||
$ app/console --help create
|
$ app/console --help create
|
||||||
|
@ -236,32 +225,30 @@ Configuration
|
||||||
|
|
||||||
### API
|
### API
|
||||||
|
|
||||||
#### Personal instance
|
**Personal instance**
|
||||||
|
|
||||||
If you install Gist on your server, you have to modify the ```base_uri``` of the API.
|
If you install Gist on your server, you have to modify the `base_uri` of the API.
|
||||||
Edit ```app/bootstrap.php.d/60-api.php``` and replace ```https://gist.deblan.org/```.
|
Edit `app/bootstrap.php.d/60-api.php` and replace `https://gist.deblan.org/`.
|
||||||
|
|
||||||
### Authentication
|
### Authentication
|
||||||
|
|
||||||
#### Disabling login
|
**Disabling login**
|
||||||
|
|
||||||
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['enable_login']` with `false`.
|
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['enable_login']` with `false`.
|
||||||
|
|
||||||
#### Disabling registration
|
**Disabling registration**
|
||||||
|
|
||||||
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['enable_registration']` with `false`.
|
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['enable_registration']` with `false`.
|
||||||
|
|
||||||
#### Force registration/login
|
**Login required to edit a gist**
|
||||||
|
|
||||||
##### Login required to edit a gist
|
|
||||||
|
|
||||||
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['login_required_to_edit_gist']` with `true`.
|
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['login_required_to_edit_gist']` with `true`.
|
||||||
|
|
||||||
##### Login required to view a gist
|
**Login required to view a gist**
|
||||||
|
|
||||||
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['login_required_to_view_gist']` with `true`.
|
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['login_required_to_view_gist']` with `true`.
|
||||||
|
|
||||||
##### Login required to view an embeded gist
|
**Login required to view an embeded gist**
|
||||||
|
|
||||||
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['login_required_to_view_embeded_gist']` with `true`.
|
Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['login_required_to_view_embeded_gist']` with `true`.
|
||||||
|
|
||||||
|
@ -269,19 +256,18 @@ Edit `app/bootstrap.php.d/70-security.php` and modify the value of `$app['login_
|
||||||
|
|
||||||
`app_dev.php` is the development router. Access is granted for an IP range defined in the same file.
|
`app_dev.php` is the development router. Access is granted for an IP range defined in the same file.
|
||||||
|
|
||||||
|
|
||||||
Deployment
|
Deployment
|
||||||
----------
|
----------
|
||||||
|
|
||||||
Gist uses [Magallanes](http://magephp.com/) to manage deployment.
|
Gist uses [Magallanes](http://magephp.com/) to manage deployment.
|
||||||
|
|
||||||
### Global installation
|
**Global installation**
|
||||||
|
|
||||||
$ composer global require andres-montanez/magallanes
|
$ composer global require andres-montanez/magallanes
|
||||||
# if the envvar PATH contains "$HOME/bin/"
|
# if the envvar PATH contains "$HOME/bin/"
|
||||||
$ ln -s ~/.composer/vendor/bin/mage ~/bin/mage
|
$ ln -s ~/.composer/vendor/bin/mage ~/bin/mage
|
||||||
|
|
||||||
### Local installation
|
**Local installation**
|
||||||
|
|
||||||
$ composer require andres-montanez/magallanes
|
$ composer require andres-montanez/magallanes
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue