mirror of
https://github.com/wallabag/wallabag.git
synced 2024-11-29 04:21:06 +00:00
Update documentation
This commit is contained in:
parent
84e3c36e02
commit
7c1225347d
9 changed files with 30 additions and 28 deletions
1
Makefile
1
Makefile
|
@ -24,6 +24,7 @@ build: ## Run grunt
|
||||||
@grunt
|
@grunt
|
||||||
|
|
||||||
test: ## Launch wallabag testsuite
|
test: ## Launch wallabag testsuite
|
||||||
|
@if [ ! -d "vendor/phpunit" ]; then composer install; fi
|
||||||
@ant prepare && vendor/phpunit/phpunit/phpunit -v
|
@ant prepare && vendor/phpunit/phpunit/phpunit -v
|
||||||
|
|
||||||
release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`).
|
release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`).
|
||||||
|
|
|
@ -17,9 +17,8 @@ Then you can install wallabag by executing the following commands:
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/wallabag/wallabag.git
|
git clone https://github.com/wallabag/wallabag.git
|
||||||
cd wallabag
|
cd wallabag && make install
|
||||||
./install.sh
|
make run
|
||||||
php bin/console server:run --env=prod
|
|
||||||
```
|
```
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
|
@ -15,23 +15,22 @@ During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`.
|
||||||
|
|
||||||
- Run these commands to create the tag:
|
- Run these commands to create the tag:
|
||||||
|
|
||||||
```
|
```
|
||||||
git checkout master
|
git checkout master
|
||||||
git pull origin master
|
git pull origin master
|
||||||
git checkout -b release-$LAST_WALLABAG_RELEASE
|
git checkout -b release-$LAST_WALLABAG_RELEASE
|
||||||
SYMFONY_ENV=prod composer up --no-dev
|
SYMFONY_ENV=prod composer up --no-dev
|
||||||
git add --force composer.lock
|
git add --force composer.lock
|
||||||
git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
|
git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
|
||||||
git push origin release-$LAST_WALLABAG_RELEASE
|
git push origin release-$LAST_WALLABAG_RELEASE
|
||||||
```
|
```
|
||||||
|
|
||||||
- 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.
|
- 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.
|
||||||
- Run these commands to create the package (you need to clone `https://github.com/wallabag/releaser`) :
|
- Run these command to create the package:
|
||||||
|
|
||||||
```
|
```
|
||||||
cd releaser/
|
make releas emaster /tmp wllbg-release prod
|
||||||
./releaser.sh $LAST_WALLABAG_RELEASE
|
```
|
||||||
```
|
|
||||||
|
|
||||||
- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
|
- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
|
||||||
- Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**).
|
- Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**).
|
||||||
|
|
|
@ -57,14 +57,13 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
|
||||||
::
|
::
|
||||||
|
|
||||||
git clone https://github.com/wallabag/wallabag.git
|
git clone https://github.com/wallabag/wallabag.git
|
||||||
cd wallabag
|
cd wallabag && make install
|
||||||
./install.sh
|
|
||||||
|
|
||||||
Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen:
|
Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
php bin/console server:run --env=prod
|
make run
|
||||||
|
|
||||||
und wallabag unter http://deineserverip:8000 erreichen.
|
und wallabag unter http://deineserverip:8000 erreichen.
|
||||||
|
|
||||||
|
|
|
@ -56,14 +56,13 @@ To install wallabag itself, you must run the following commands:
|
||||||
::
|
::
|
||||||
|
|
||||||
git clone https://github.com/wallabag/wallabag.git
|
git clone https://github.com/wallabag/wallabag.git
|
||||||
cd wallabag
|
cd wallabag && make install
|
||||||
./install.sh
|
|
||||||
|
|
||||||
To start PHP's build-in server and test if everything did install correctly, you can do:
|
To start PHP's build-in server and test if everything did install correctly, you can do:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
php bin/console server:run --env=prod
|
make run
|
||||||
|
|
||||||
And access wallabag at http://yourserverip:8000
|
And access wallabag at http://yourserverip:8000
|
||||||
|
|
||||||
|
@ -240,12 +239,12 @@ Rights access to the folders of the project
|
||||||
Test environment
|
Test environment
|
||||||
~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
When 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.
|
When 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.
|
||||||
|
|
||||||
Production environment
|
Production environment
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
As 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.
|
As 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.
|
||||||
|
|
||||||
To 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).
|
To 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).
|
||||||
|
|
||||||
|
|
|
@ -54,14 +54,13 @@ Pour installer wallabag, vous devez exécuter ces commandes :
|
||||||
::
|
::
|
||||||
|
|
||||||
git clone https://github.com/wallabag/wallabag.git
|
git clone https://github.com/wallabag/wallabag.git
|
||||||
cd wallabag
|
cd wallabag && make install
|
||||||
./install.sh
|
|
||||||
|
|
||||||
Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
|
Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
php bin/console server:run --env=prod
|
make run
|
||||||
|
|
||||||
Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
|
Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
#! /usr/bin/env bash
|
#! /usr/bin/env bash
|
||||||
|
# You can execute this file to install wallabag
|
||||||
|
# eg: `sh install.sh prod`
|
||||||
|
|
||||||
ENV=$1
|
ENV=$1
|
||||||
TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
|
TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
#! /usr/bin/env bash
|
#! /usr/bin/env bash
|
||||||
|
# You can execute this file to create a new package for wallabag
|
||||||
|
# eg: `sh release.sh master /tmp wllbg-release prod`
|
||||||
|
|
||||||
VERSION=$1
|
VERSION=$1
|
||||||
TMP_FOLDER=$2
|
TMP_FOLDER=$2
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
#! /usr/bin/env bash
|
#! /usr/bin/env bash
|
||||||
|
# You can execute this file to update wallabag
|
||||||
|
# eg: `sh update.sh prod`
|
||||||
|
|
||||||
ENV=$1
|
ENV=$1
|
||||||
TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
|
TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
|
||||||
|
|
Loading…
Reference in a new issue