aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-10-10 10:20:32 +0200
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-10-10 10:20:32 +0200
commit7c1225347db8b516cc268709939f6b359bc283c1 (patch)
tree7a516132f42dbb9e8c3bf371dfd100088d50efdf
parent84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660 (diff)
downloadwallabag-7c1225347db8b516cc268709939f6b359bc283c1.tar.gz
wallabag-7c1225347db8b516cc268709939f6b359bc283c1.tar.zst
wallabag-7c1225347db8b516cc268709939f6b359bc283c1.zip
Update documentation
-rwxr-xr-xMakefile1
-rw-r--r--README.md5
-rw-r--r--RELEASE_PROCESS.md27
-rw-r--r--docs/de/user/installation.rst5
-rw-r--r--docs/en/user/installation.rst9
-rw-r--r--docs/fr/user/installation.rst5
-rw-r--r--scripts/install.sh2
-rw-r--r--scripts/release.sh2
-rw-r--r--scripts/update.sh2
9 files changed, 30 insertions, 28 deletions
diff --git a/Makefile b/Makefile
index e99367f6..1c6c0d53 100755
--- a/Makefile
+++ b/Makefile
@@ -24,6 +24,7 @@ build: ## Run grunt
24 @grunt 24 @grunt
25 25
26test: ## Launch wallabag testsuite 26test: ## Launch wallabag testsuite
27 @if [ ! -d "vendor/phpunit" ]; then composer install; fi
27 @ant prepare && vendor/phpunit/phpunit/phpunit -v 28 @ant prepare && vendor/phpunit/phpunit/phpunit -v
28 29
29release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`). 30release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`).
diff --git a/README.md b/README.md
index 8de3279d..c9488288 100644
--- a/README.md
+++ b/README.md
@@ -17,9 +17,8 @@ Then you can install wallabag by executing the following commands:
17 17
18``` 18```
19git clone https://github.com/wallabag/wallabag.git 19git clone https://github.com/wallabag/wallabag.git
20cd wallabag 20cd wallabag && make install
21./install.sh 21make run
22php bin/console server:run --env=prod
23``` 22```
24 23
25# License 24# License
diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
index 627bd844..767f5e26 100644
--- a/RELEASE_PROCESS.md
+++ b/RELEASE_PROCESS.md
@@ -15,23 +15,22 @@ During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`.
15 15
16- Run these commands to create the tag: 16- Run these commands to create the tag:
17 17
18 ``` 18```
19 git checkout master 19git checkout master
20 git pull origin master 20git pull origin master
21 git checkout -b release-$LAST_WALLABAG_RELEASE 21git checkout -b release-$LAST_WALLABAG_RELEASE
22 SYMFONY_ENV=prod composer up --no-dev 22SYMFONY_ENV=prod composer up --no-dev
23 git add --force composer.lock 23git add --force composer.lock
24 git commit -m "Release wallabag $LAST_WALLABAG_RELEASE" 24git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
25 git push origin release-$LAST_WALLABAG_RELEASE 25git push origin release-$LAST_WALLABAG_RELEASE
26 ``` 26```
27 27
28- Create a new pull request with this title `DON'T MERGE Release wallabag $LAST_WALLABAG_RELEASE`. This pull request is used to launch builds on Travis-CI. 28- Create a new pull request with this title `DON'T MERGE Release wallabag $LAST_WALLABAG_RELEASE`. This pull request is used to launch builds on Travis-CI.
29- Run these commands to create the package (you need to clone `https://github.com/wallabag/releaser`) : 29- Run these command to create the package:
30 30
31 ``` 31```
32 cd releaser/ 32make releas emaster /tmp wllbg-release prod
33 ./releaser.sh $LAST_WALLABAG_RELEASE 33```
34 ```
35 34
36- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package. 35- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
37- Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**). 36- Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**).
diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst
index bee3249b..2bb86269 100644
--- a/docs/de/user/installation.rst
+++ b/docs/de/user/installation.rst
@@ -57,14 +57,13 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
57:: 57::
58 58
59 git clone https://github.com/wallabag/wallabag.git 59 git clone https://github.com/wallabag/wallabag.git
60 cd wallabag 60 cd wallabag && make install
61 ./install.sh
62 61
63Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: 62Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen:
64 63
65:: 64::
66 65
67 php bin/console server:run --env=prod 66 make run
68 67
69und wallabag unter http://deineserverip:8000 erreichen. 68und wallabag unter http://deineserverip:8000 erreichen.
70 69
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 0920b976..e08e0306 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -56,14 +56,13 @@ To install wallabag itself, you must run the following commands:
56:: 56::
57 57
58 git clone https://github.com/wallabag/wallabag.git 58 git clone https://github.com/wallabag/wallabag.git
59 cd wallabag 59 cd wallabag && make install
60 ./install.sh
61 60
62To start PHP's build-in server and test if everything did install correctly, you can do: 61To start PHP's build-in server and test if everything did install correctly, you can do:
63 62
64:: 63::
65 64
66 php bin/console server:run --env=prod 65 make run
67 66
68And access wallabag at http://yourserverip:8000 67And access wallabag at http://yourserverip:8000
69 68
@@ -240,12 +239,12 @@ Rights access to the folders of the project
240Test environment 239Test environment
241~~~~~~~~~~~~~~~~ 240~~~~~~~~~~~~~~~~
242 241
243When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. 242When we just want to test wallabag, we just run the command ``make run`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem.
244 243
245Production environment 244Production environment
246~~~~~~~~~~~~~~~~~~~~~~ 245~~~~~~~~~~~~~~~~~~~~~~
247 246
248As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. 247As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``make run`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project.
249 248
250To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). 249To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used).
251 250
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index 55614d72..b32707f8 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -54,14 +54,13 @@ Pour installer wallabag, vous devez exécuter ces commandes :
54:: 54::
55 55
56 git clone https://github.com/wallabag/wallabag.git 56 git clone https://github.com/wallabag/wallabag.git
57 cd wallabag 57 cd wallabag && make install
58 ./install.sh
59 58
60Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : 59Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
61 60
62:: 61::
63 62
64 php bin/console server:run --env=prod 63 make run
65 64
66Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 65Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
67 66
diff --git a/scripts/install.sh b/scripts/install.sh
index 755aac1c..54d0bb78 100644
--- a/scripts/install.sh
+++ b/scripts/install.sh
@@ -1,4 +1,6 @@
1#! /usr/bin/env bash 1#! /usr/bin/env bash
2# You can execute this file to install wallabag
3# eg: `sh install.sh prod`
2 4
3ENV=$1 5ENV=$1
4TAG=$(git describe --tags $(git rev-list --tags --max-count=1)) 6TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
diff --git a/scripts/release.sh b/scripts/release.sh
index 3d096430..e118b87e 100644
--- a/scripts/release.sh
+++ b/scripts/release.sh
@@ -1,4 +1,6 @@
1#! /usr/bin/env bash 1#! /usr/bin/env bash
2# You can execute this file to create a new package for wallabag
3# eg: `sh release.sh master /tmp wllbg-release prod`
2 4
3VERSION=$1 5VERSION=$1
4TMP_FOLDER=$2 6TMP_FOLDER=$2
diff --git a/scripts/update.sh b/scripts/update.sh
index 48281210..b920a829 100644
--- a/scripts/update.sh
+++ b/scripts/update.sh
@@ -1,4 +1,6 @@
1#! /usr/bin/env bash 1#! /usr/bin/env bash
2# You can execute this file to update wallabag
3# eg: `sh update.sh prod`
2 4
3ENV=$1 5ENV=$1
4TAG=$(git describe --tags $(git rev-list --tags --max-count=1)) 6TAG=$(git describe --tags $(git rev-list --tags --max-count=1))