Skip to content

Commit 5c81f49

Browse files
corpseecorpsee
committed
Merge branch 'release-2.0'
2 parents e323298 + e024be5 commit 5c81f49

53 files changed

Lines changed: 191 additions & 189 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 3 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -86,126 +86,11 @@ See [milestones](https://github.com/php-censor/php-censor/milestones).
8686

8787
## Installing
8888

89-
* Go to the directory in which you want to install PHP Censor, for example: `/var/www`:
90-
91-
```bash
92-
cd /var/www
93-
```
94-
95-
* Create project by Composer:
96-
97-
```bash
98-
composer create-project \
99-
php-censor/php-censor \
100-
php-censor.local \
101-
--keep-vcs
102-
```
103-
104-
Or download [latest archive](https://github.com/php-censor/php-censor/releases/latest) from GitHub, unzip it and run
105-
`composer install`.
106-
107-
* Create an empty database for your application (MySQL/MariaDB or PostgreSQL);
108-
109-
* Install Beanstalkd Queue (Optional, if you are going to use a queue with Worker):
110-
111-
```bash
112-
# For Debian-based
113-
aptitude install beanstalkd
114-
# Check if the service is running:
115-
/etc/init.d/beanstalkd status
116-
# If it's not running, start it:
117-
/etc/init.d/beanstalkd start
118-
```
119-
120-
* Install PHP Censor itself:
121-
122-
```bash
123-
cd ./php-censor.local
124-
125-
# Interactive installation
126-
./bin/console php-censor:install
127-
128-
# Non-interactive installation
129-
./bin/console php-censor:install \
130-
--url='http://php-censor.local' \
131-
--db-type=pgsql \
132-
--db-host=localhost \
133-
--db-pgsql-sslmode=prefer \
134-
--db-name=php-censor \
135-
--db-user=php-censor \
136-
--db-password=php-censor \
137-
--db-port=default \ # Value 'default': 5432 for PostgreSQL and 3306 for MySQL
138-
--admin-name=admin \
139-
--admin-password=admin \
140-
--admin-email='admin@php-censor.local' \
141-
--queue-host=localhost \
142-
--queue-port=11300 \
143-
--queue-name=php-censor
144-
145-
# Non-interactive installation with prepared config.yml file
146-
./bin/console php-censor:install \
147-
--config-from-file=yes \
148-
--admin-name=admin \
149-
--admin-password=admin \
150-
--admin-email='admin@php-censor.local'
151-
```
152-
153-
* [Add a virtual host to your web server](docs/en/virtual_host.md), pointing to the `public` directory within your new
154-
PHP Censor directory. You'll need to set up rewrite rules to point all non-existent requests to PHP Censor;
155-
156-
* [Set up the PHP Censor Worker](docs/en/workers/worker.md);
157-
158-
## Installing via Docker
159-
160-
If you want to install PHP Censor as a Docker container, you can use
161-
[php-censor/docker-php-censor](https://github.com/php-censor/docker-php-censor) project.
89+
See [Installing](docs/en/installing.md) section in documentation;
16290

16391
## Updating
16492

165-
* Go to your PHP Censor directory (to `/var/www/php-censor.local` for example):
166-
167-
```bash
168-
cd /var/www/php-censor.local
169-
```
170-
171-
* Pull the latest code from the repository by Git (If you want the latest `master` branch):
172-
173-
```bash
174-
git checkout master
175-
git pull -r
176-
```
177-
178-
Or pull the latest version:
179-
180-
```bash
181-
git fetch
182-
git checkout <version>
183-
```
184-
185-
* Update the Composer dependencies: `composer install`
186-
187-
* Update the database scheme:
188-
189-
```bash
190-
./bin/console php-censor-migrations:migrate
191-
```
192-
193-
* Restart Supervisord workers (If you use workers and Supervisord):
194-
195-
```bash
196-
sudo supervisorctl status
197-
sudo supervisorctl restart <worker:worker_00>
198-
...
199-
sudo supervisorctl restart <worker:worker_nn>
200-
```
201-
202-
Or restart Systemd workers (If you use workers and Systemd):
203-
204-
```bash
205-
sudo systemctl restart <worker@1.service>
206-
...
207-
sudo systemctl restart <worker@n.service>
208-
```
93+
See [Updating](docs/en/updating.md) section in documentation;
20994

21095
## Configuring project
21196

@@ -240,7 +125,7 @@ complete:
240125
default_mailto_address: admin@php-censor.local
241126
```
242127
243-
More details about [configuring project](docs/en/configuring_project.md).
128+
More details about [configuring project](docs/en/configuring_project.md) in documentation.
244129
245130
## Migrations
246131

‎docs/en/README.md‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ PHP Censor Documentation
44
Getting Started
55
---------------
66

7-
* [Installing PHP Censor](../../README.md#installing)
7+
* [Installing PHP Censor](installing.md)
88
* [Adding a virtual host](virtual_host.md)
99
* [Run builds using a worker](workers/worker.md)
1010
* [Adding PHP Censor support to your projects](configuring_project.md)
11-
* [Updating PHP Censor](../../README.md#updating)
11+
* [Updating PHP Censor](updating.md)
1212
* [Configuring PHP Censor](configuring_application.md)
1313

1414
Using PHP Censor
@@ -34,22 +34,20 @@ Using PHP Censor
3434
Plugins
3535
-------
3636

37-
### Internal Plugins
38-
39-
#### Dependencies
37+
### Dependencies
4038

4139
* [Composer](plugins/composer.md) - `composer`
4240
* [Security Checker](plugins/security_checker.md) - SensioLabs Security Checker Plugin (`security_checker`).
4341

44-
#### Tests
42+
### Tests
4543

4644
* [Atoum](plugins/atoum.md) - `atoum`
4745
* [Behat](plugins/behat.md) - `behat`
4846
* [Codeception](plugins/codeception.md) - `codeception`
4947
* [PHP Unit](plugins/php_unit.md) - `php_unit`
5048
* [PHP Spec](plugins/php_spec.md) - `php_spec`
5149

52-
#### Code Style
50+
### Code Style
5351

5452
* [Lint](plugins/lint.md) - `lint`
5553
* [PDepend](plugins/pdepend.md) - `pdepend`
@@ -69,21 +67,21 @@ Plugins
6967
* [Technical Debt](plugins/technical_debt.md) - `technical_debt`
7068
* [SensioLabs Insight](plugins/sensiolabs_insight.md) - `sensiolabs_insight`
7169

72-
#### Databases
70+
### Databases
7371

7472
* [MySQL](plugins/mysql.md) - `mysql`
7573
* [PostgreSQL](plugins/pgsql.md) - `pgsql`
7674
* [SQLite](plugins/sqlite.md) - `sqlite`
7775

78-
#### Deployment
76+
### Deployment
7977

8078
* [Mage](plugins/mage.md) - `mage`
8179
* [Mage v3](plugins/mage3.md) - `mage3`
8280
* [Phing](plugins/phing.md) - `phing`
8381
* [Deployer](plugins/deployer.md) - `deployer`
8482
* [DeployerOrg](plugins/deployer_org.md) - `deployer_org`
8583

86-
#### Notifications
84+
### Notifications
8785

8886
* [Campfire](plugins/campfire_notify.md) - `campfire_notify`
8987
* [Email](plugins/email_notify.md) - `email_notify`
@@ -95,7 +93,7 @@ Plugins
9593
* [Webhook](plugins/webhook_notify.md) - `webhook_notify`
9694
* [XMPP](plugins/xmpp_notify.md) - `xmpp_notify`
9795

98-
#### Other
96+
### Other
9997

10098
* [Clean Build](plugins/clean_build.md) - `clean_build`
10199
* [Copy Build](plugins/copy_build.md) - `copy_build`

‎docs/en/configuring_project.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ is also a `binary_name` option which allows to set an alternative name for the e
230230
of strings).
231231

232232
Example:
233-
```yaml
233+
```yml
234234
setup:
235235
composer:
236236
priority_path: binary_path

‎docs/en/installing.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
Installing
2+
==========
3+
4+
* Go to the directory in which you want to install PHP Censor, for example: `/var/www`:
5+
6+
```bash
7+
cd /var/www
8+
```
9+
10+
* Create project by Composer:
11+
12+
```bash
13+
composer create-project \
14+
php-censor/php-censor \
15+
php-censor.local \
16+
--keep-vcs
17+
```
18+
19+
Or download [latest archive](https://github.com/php-censor/php-censor/releases/latest) from GitHub, unzip it and run
20+
`composer install`.
21+
22+
* Create an empty database for your application (MySQL/MariaDB or PostgreSQL);
23+
24+
* Install Beanstalkd Queue (Optional, if you are going to use a queue with Worker):
25+
26+
```bash
27+
# For Debian-based
28+
aptitude install beanstalkd
29+
```
30+
31+
* Install PHP Censor itself:
32+
33+
```bash
34+
cd ./php-censor.local
35+
36+
# Interactive installation
37+
./bin/console php-censor:install
38+
39+
# Non-interactive installation
40+
./bin/console php-censor:install \
41+
--url='http://php-censor.local' \
42+
--db-type=pgsql \
43+
--db-host=localhost \
44+
--db-pgsql-sslmode=prefer \
45+
--db-name=php-censor \
46+
--db-user=php-censor \
47+
--db-password=php-censor \
48+
--db-port=default \ # Value 'default': 5432 for PostgreSQL and 3306 for MySQL
49+
--admin-name=admin \
50+
--admin-password=admin \
51+
--admin-email='admin@php-censor.local' \
52+
--queue-host=localhost \
53+
--queue-port=11300 \
54+
--queue-name=php-censor
55+
56+
# Non-interactive installation with prepared config.yml file
57+
./bin/console php-censor:install \
58+
--config-from-file=yes \
59+
--admin-name=admin \
60+
--admin-password=admin \
61+
--admin-email='admin@php-censor.local'
62+
```
63+
64+
* [Add a virtual host to your web server](docs/en/virtual_host.md), pointing to the `public` directory within your new
65+
PHP Censor directory. You'll need to set up rewrite rules to point all non-existent requests to PHP Censor;
66+
67+
* [Set up the PHP Censor Worker](docs/en/workers/worker.md);
68+
69+
## Installing via Docker
70+
71+
If you want to install PHP Censor as a Docker container, you can use
72+
[php-censor/docker-php-censor](https://github.com/php-censor/docker-php-censor) project.

‎docs/en/periodical_builds.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can create periodical builds for your projects. For starting use periodical
77

88
Periodical builds config example:
99

10-
```yaml
10+
```yml
1111
projects:
1212
1: # Project id
1313
branches: # Branch list for periodical build

‎docs/en/plugins/atoum.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Configuration
1313
Atom binary).
1414

1515
### Examples
16-
```yaml
16+
```yml
1717
test:
1818
atoum:
1919
args: "command line arguments go here"

‎docs/en/plugins/behat.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Configuration
1212

1313
### Examples
1414

15-
```yaml
15+
```yml
1616
test:
1717
behat:
1818
executable: "path to behat binary"

‎docs/en/plugins/bitbucket_notify.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Configuration
1919

2020
### Examples
2121

22-
```yaml
22+
```yml
2323
complete:
2424
bitbucket_notify:
2525
url: "https://bitbucket.yourhost.de"

‎docs/en/plugins/campfire_notify.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Configuration
2121

2222
### Examples
2323

24-
```yaml
24+
```yml
2525
build_settings:
2626
campfire_notify:
2727
auth_token: "campfire auth token"

‎docs/en/plugins/clean_build.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Configuration
1313

1414
### Examples
1515

16-
```yaml
16+
```yml
1717
complete:
1818
clean_build:
1919
remove:

0 commit comments

Comments
 (0)