Compare commits
346 Commits
2.0.0-beta
...
2.0.6
| Author | SHA1 | Date | |
|---|---|---|---|
| 97781ee967 | |||
| 8617972f3f | |||
| a26f91dcb6 | |||
| 029965b6a2 | |||
| 75ac3e6289 | |||
| 8c7d7c0300 | |||
| 57c608fa94 | |||
| 40288b7166 | |||
| 78d1727096 | |||
| 0e1abf392c | |||
| f64472e9f8 | |||
| 39f27d6370 | |||
| 317fc6e684 | |||
| 8d8d48a2bb | |||
| 0dc09439ef | |||
| ab3eb4ba95 | |||
| 57b62cbf79 | |||
| 1973897305 | |||
| 51cbc2ebfe | |||
| 8d4152f70d | |||
| baef8ea26c | |||
| 9f8c43e222 | |||
| fdc90ceb17 | |||
| 2bc9cad78e | |||
| fb5c17a9ab | |||
| 95859e54c5 | |||
| bf27f99d54 | |||
| 2c00dddf01 | |||
| 1bdbc39f02 | |||
| b46124cb9b | |||
| d37bb05c88 | |||
| 99451fe4b7 | |||
| 23634d5d84 | |||
| 891a026e31 | |||
| 2f30eed236 | |||
| 247cf4897a | |||
| 3c552f0d04 | |||
| ce0e9ec31b | |||
| d71b600599 | |||
| 77c530f43c | |||
| 429480357f | |||
| d220a95121 | |||
| 02d10905b3 | |||
| 1584067028 | |||
| 17dfff6918 | |||
| f329e769fd | |||
| 3be047456d | |||
| 39ba51ca1a | |||
| 2c045a210a | |||
| f41c840b8c | |||
| 839475776b | |||
| 7b67f785ff | |||
| c15a150d2e | |||
| 92491227c1 | |||
| b5fa6607a9 | |||
| 4127d7ad1b | |||
| 2857aaa994 | |||
| 8fef96ee9f | |||
| 9f95b14dec | |||
| 151f046f61 | |||
| 6922168420 | |||
| e7658cb009 | |||
| 2dcb1dbf05 | |||
| 871f667a55 | |||
| d30ec39008 | |||
| 8baf3d4bda | |||
| 953305e904 | |||
| 9b40422594 | |||
| bba271e619 | |||
| 614a0bfd86 | |||
| 873e380658 | |||
| cac3f603cf | |||
| 5f2971e1d4 | |||
| f7e714bde7 | |||
| 458854f1e4 | |||
| e0f953a5a6 | |||
| 12f8631e8a | |||
| 9b8d1d8bbf | |||
| 30334567a3 | |||
| e2f2f61001 | |||
| 4ca4d1b3b1 | |||
| 733b2cf19b | |||
| acd3c26a74 | |||
| b1fcd47a5c | |||
| d948ee531e | |||
| 1875afaeff | |||
| ab46a256f4 | |||
| de20470ee1 | |||
| 8f705d62af | |||
| 3c8be33500 | |||
| 961ec4ec86 | |||
| 1221f5315d | |||
| 1556c925a4 | |||
| f54de6817e | |||
| dcd74397d6 | |||
| a0640406b4 | |||
| 8cae66fa74 | |||
| 02222d9070 | |||
| 613bff2d82 | |||
| e0f4f25fd6 | |||
| c6b1112b11 | |||
| 3bd50951be | |||
| 7c1f64c967 | |||
| bb7a39d1ed | |||
| d9926005b1 | |||
| 8b563fc04e | |||
| 8ae9a3f52f | |||
| 9039103c37 | |||
| 09e5b9391e | |||
| e7cd089fa6 | |||
| 12c697562e | |||
| fa04bddd01 | |||
| e546a2d6eb | |||
| 9b57bac8b9 | |||
| 7f76f416d1 | |||
| 27b96824fc | |||
| 760875af67 | |||
| 8b09c6edfb | |||
| 439c7e41a3 | |||
| bba9907d1f | |||
| 97c8eb3c23 | |||
| e9023a16eb | |||
| 2142c714ef | |||
| 045859a2b5 | |||
| 2a007fe43d | |||
| c4c062cce0 | |||
| 8389074180 | |||
| ba9fee0855 | |||
| b8f35b6b27 | |||
| 06bf24103b | |||
| 12d3bbccbd | |||
| deb5d97667 | |||
| 51a15609b3 | |||
| 823397f2d6 | |||
| f0de35d2ee | |||
| 66bbaaae4d | |||
| d3ffd65a06 | |||
| 46bbbbf4a9 | |||
| 4c05e8b18f | |||
| 4c295cb928 | |||
| 87b8461ed8 | |||
| 9ddf49ba24 | |||
| edf3e88d88 | |||
| 10cc2785a0 | |||
| acc371a129 | |||
| ef37b9af71 | |||
| d6a9e139dc | |||
| d8f8a59010 | |||
| f97653c895 | |||
| 58f0d0bdeb | |||
| 3cfbe3c7e8 | |||
| 8c2affe680 | |||
| c9bdd9a83f | |||
| 0e9339c46c | |||
| 9c0bc04cfe | |||
| dafde7fb2f | |||
| 9481187896 | |||
| 1c90663b79 | |||
| 7d5b4631d0 | |||
| 9f151b469f | |||
| 45919a295e | |||
| 2499cdbf29 | |||
| 868e76af10 | |||
| f88530de68 | |||
| 4a25bef077 | |||
| 24f65a838c | |||
| 89bafa95ed | |||
| 18bb5a90d5 | |||
| 938a16c0f6 | |||
| ca8d61b958 | |||
| 23feba63bb | |||
| 3320d39418 | |||
| 23d24b1750 | |||
| dc12084d93 | |||
| 0907a72c64 | |||
| 188b74b6df | |||
| 71601c171f | |||
| 5c2c1a6434 | |||
| 7fdecbb73c | |||
| 1f034a3316 | |||
| d1f4996b77 | |||
| 5180302650 | |||
| 2d899e8d30 | |||
| 345d74268b | |||
| 4086e0782e | |||
| af497a641c | |||
| f2e5fdc366 | |||
| a417b86923 | |||
| 18078ded12 | |||
| 245e2e2cae | |||
| 86732aa01c | |||
| c31ea8a409 | |||
| c95e39c51a | |||
| 63995be5ee | |||
| 1880da7420 | |||
| 76cd8dbb05 | |||
| 624a7c6df1 | |||
| 80bd17f00d | |||
| 1b8b3859c0 | |||
| 443cff9840 | |||
| 4094ea4771 | |||
| 7eccbda99f | |||
| 8846ad0a90 | |||
| 41e79f9792 | |||
| 637dc4bb21 | |||
| a83fbf4504 | |||
| d098cb04a8 | |||
| 574d101561 | |||
| 386d1120c3 | |||
| 15e9483323 | |||
| c5dede8445 | |||
| e9497f6fc0 | |||
| c71d83b60c | |||
| f642863ff2 | |||
| 69c21157ba | |||
| 9b2fe57eb6 | |||
| b351d0494b | |||
| 6d0db75328 | |||
| 615fc1d237 | |||
| 61fcbe9f57 | |||
| eaec84fcd3 | |||
| 834efe84ac | |||
| 466c0c6684 | |||
| 661d5ae0cf | |||
| dd4997d705 | |||
| c29747357a | |||
| 0135c98b24 | |||
| cea846d407 | |||
| 54ecbb41d6 | |||
| 19a7ea2a44 | |||
| 2504fe46ed | |||
| 82dbd47391 | |||
| 7ead8a0d9d | |||
| cb48a569e0 | |||
| 5c3ca4fe9e | |||
| 808f541ea9 | |||
| 7a2157b8d7 | |||
| b00a89e08f | |||
| 015e4284f0 | |||
| f652f41dab | |||
| 7704ef5d3f | |||
| e969c2a7ef | |||
| 5b732257db | |||
| 0c608f1183 | |||
| 77b9db87b8 | |||
| 6a986910b6 | |||
| c6cbe75b2e | |||
| 9479ae834c | |||
| c802181126 | |||
| 8687bcd0c9 | |||
| 4b0b77e4d7 | |||
| e543d03fd7 | |||
| 6d3a3cfcda | |||
| 4a749cad8d | |||
| 3a7df76013 | |||
| af47742dd0 | |||
| 52d806ea6b | |||
| 48bb9675c1 | |||
| 6b82630838 | |||
| b5cf84bdf6 | |||
| a119acd15d | |||
| 7d997fd9f6 | |||
| 163517da79 | |||
| 0795d04916 | |||
| eff75729a1 | |||
| 2ff626a451 | |||
| c61b68e8a6 | |||
| d92407041a | |||
| 187868d137 | |||
| 1695a6fecd | |||
| cb68c76cd8 | |||
| 69726ec78e | |||
| 12500bd772 | |||
| 1c7690d586 | |||
| dc89968c58 | |||
| 9191d8a640 | |||
| 0bb5669cf6 | |||
| b637526524 | |||
| 4063d821a3 | |||
| e2dda63152 | |||
| 0b05dae377 | |||
| ff6b683bb3 | |||
| b787a7757e | |||
| 0e49487bb0 | |||
| ba2157b270 | |||
| cc8c2d315f | |||
| a2d6f6e9d8 | |||
| 8f336fda64 | |||
| 4d0ec0e721 | |||
| 5d6f6f56a2 | |||
| 2baca964f3 | |||
| 4e38769ad0 | |||
| 18b812b1b9 | |||
| ce25b98132 | |||
| 4dc9f8d037 | |||
| 005c0d370f | |||
| 26880205a7 | |||
| 2f20bb2b7f | |||
| 58a0ca1651 | |||
| 5791e4f458 | |||
| a6ab1e6d56 | |||
| 48581c90a1 | |||
| 842a62e293 | |||
| 4258033451 | |||
| 7dbed56857 | |||
| 5a4ee4ae0f | |||
| 439b36323e | |||
| 4083887afe | |||
| f3e49264f2 | |||
| 4cb3ef5125 | |||
| f92b5de7ac | |||
| 1381db4835 | |||
| 3fae7f1d08 | |||
| a0c6c244d9 | |||
| b308b26339 | |||
| 4204a06b77 | |||
| 4f9cf232f8 | |||
| 0d42217e4e | |||
| d2b4f01d74 | |||
| e71c376db9 | |||
| bd46de6b25 | |||
| 169d60abc7 | |||
| f39e94ace3 | |||
| 1b64a84b78 | |||
| ec7c67badc | |||
| 78becd5401 | |||
| 1978d0e3b6 | |||
| bc2b947cd5 | |||
| 0cd0d6eb8c | |||
| 2f60e5ea75 | |||
| 189ef6342a | |||
| 0d3043a29c | |||
| 2cc7de1e93 | |||
| 3500d4099f | |||
| 3107f92acb | |||
| 17051137ec | |||
| bc44aa5784 | |||
| 6432b9277e | |||
| 37b371726b | |||
| db1d4b1e19 | |||
| 889c1cf328 | |||
| bca5485946 | |||
| 17b3d026fd | |||
| 5cc9b5151f | |||
| 7d1fdab2bb | |||
| c9c8345a4a |
17
.github/CONTRIBUTING.md
vendored
@ -3,22 +3,11 @@
|
||||
## You found a bug
|
||||
Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
|
||||
|
||||
To fix the bug quickly, we need some infos:
|
||||
* your wallabag version (in `app/config/config.yml`, see `wallabag_core.version`)
|
||||
* your webserver installation :
|
||||
* type of hosting (shared or dedicated)
|
||||
* in case of a dedicated server, the server and OS used
|
||||
* the php version used, eventually `phpinfo()`
|
||||
* which storage system you choose at install (SQLite, MySQL/MariaDB or PostgreSQL)
|
||||
* any particular details which could be related
|
||||
To fix the bug quickly, we need some infos: please answer to the questions in the issue form.
|
||||
|
||||
If relevant :
|
||||
* the link you want to save and which causes problem
|
||||
* the file you want to import into wallabag, or just an extract
|
||||
|
||||
If you have the skills, look for errors into php, server and application (see `var/logs`) logs
|
||||
If you have the skills, look for errors into php, server and application (see `var/logs`) logs.
|
||||
|
||||
Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like.
|
||||
|
||||
## You want to fix a bug or to add a feature
|
||||
Please fork wallabag and work with **the v2 branch** only. **Do not work on master branch**.
|
||||
Please fork wallabag and work with **the master branch**.
|
||||
|
||||
2
.github/ISSUE_TEMPLATE.md
vendored
@ -6,7 +6,7 @@ Remember, this is _not_ a place to ask questions. For that, go to http://gitter.
|
||||
### Environment
|
||||
|
||||
* wallabag version (or git revision) that exhibits the issue:
|
||||
* How did you install wallabag? Via `composer create-project` or by downloading the package?
|
||||
* How did you install wallabag? Via `git clone` or by downloading the package?
|
||||
* Last wallabag version that did not exhibit the issue (if applicable):
|
||||
* php version:
|
||||
* OS:
|
||||
|
||||
3
.gitignore
vendored
@ -10,6 +10,9 @@
|
||||
/var/sessions/*
|
||||
!var/sessions/.gitkeep
|
||||
!var/SymfonyRequirements.php
|
||||
/bin/*
|
||||
!/bin/console
|
||||
!/bin/symfony_requirements
|
||||
|
||||
# Parameters
|
||||
/app/config/parameters.yml
|
||||
|
||||
18
.travis.yml
@ -11,6 +11,7 @@ addons:
|
||||
|
||||
# cache vendor dirs
|
||||
cache:
|
||||
apt: true
|
||||
directories:
|
||||
- vendor
|
||||
- $HOME/.composer/cache
|
||||
@ -19,15 +20,19 @@ php:
|
||||
- 5.5
|
||||
- 5.6
|
||||
- 7.0
|
||||
- nightly
|
||||
- hhvm
|
||||
|
||||
env:
|
||||
- DB=mysql
|
||||
- DB=pgsql
|
||||
- DB=sqlite
|
||||
- DB=mysql
|
||||
- DB=pgsql
|
||||
- DB=sqlite
|
||||
|
||||
matrix:
|
||||
fast_finish: true
|
||||
include:
|
||||
- php: 7.0
|
||||
env: CS_FIXER=run VALIDATE_TRANSLATION_FILE=run DB=sqlite
|
||||
exclude:
|
||||
- php: hhvm
|
||||
env: DB=pgsql # driver for PostgreSQL currently unsupported by HHVM, requires 3rd party dependency
|
||||
@ -37,8 +42,7 @@ matrix:
|
||||
# exclude v1 branches
|
||||
branches:
|
||||
except:
|
||||
- master
|
||||
- dev
|
||||
- legacy
|
||||
|
||||
before_script:
|
||||
- if [[ $TRAVIS_PHP_VERSION != hhvm ]]; then echo "memory_limit=-1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini; fi;
|
||||
@ -52,4 +56,6 @@ before_install:
|
||||
script:
|
||||
- travis_wait composer update --no-interaction --no-progress
|
||||
- ant prepare-$DB
|
||||
- bin/phpunit -v
|
||||
- phpunit -v
|
||||
- if [ "$CS_FIXER" = "run" ]; then php bin/php-cs-fixer fix src/ --verbose --dry-run ; fi;
|
||||
- if [ "$VALIDATE_TRANSLATION_FILE" = "run" ]; then php bin/console lint:yaml src/Wallabag/CoreBundle/Resources/translations -v ; fi;
|
||||
|
||||
158
CHANGELOG.md
Normal file
@ -0,0 +1,158 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
|
||||
|
||||
## [2.0.6] - 2016-08-10
|
||||
|
||||
### Changed
|
||||
|
||||
- [#2199](https://github.com/wallabag/wallabag/pull/2199) Handling socials links into a config file (Simon Alberny)
|
||||
- [#2172](https://github.com/wallabag/wallabag/pull/2172) Change the way to login user in tests (Jeremy Benoist)
|
||||
- [#2155](https://github.com/wallabag/wallabag/pull/2155) Use friendsofphp instead of fabpot for PHP CS Fixer (Jeremy Benoist)
|
||||
|
||||
### Fixed
|
||||
|
||||
- [#2200](https://github.com/wallabag/wallabag/pull/2200) Fixed typo in entry:notice:entry_saved (charno6)
|
||||
- [#2185](https://github.com/wallabag/wallabag/pull/2185) Fix 3rd-Party Apps links (Chrome & Firefox) (Thomas Citharel)
|
||||
- [#2165](https://github.com/wallabag/wallabag/pull/2165) Fix a few french translations typos (Thomas Citharel)
|
||||
- [#2157](https://github.com/wallabag/wallabag/pull/2157) Handle only upper or only lower reading filter (Jeremy Benoist)
|
||||
- [#2156](https://github.com/wallabag/wallabag/pull/2156) Try to find bad redirection after delete (Jeremy Benoist)
|
||||
|
||||
## [2.0.5] - 2016-05-31
|
||||
|
||||
### Added
|
||||
|
||||
- [#2052](https://github.com/wallabag/wallabag/pull/2052) Add unread filter to entries pages (Dan Bartram)
|
||||
|
||||
### Changed
|
||||
|
||||
- [#2093](https://github.com/wallabag/wallabag/pull/2093) Replace vertical dots in material theme with horizontal dots (Nicolas Lœuillet)
|
||||
- [#2054](https://github.com/wallabag/wallabag/pull/2054) Update italian translation (Daniele Conca)
|
||||
- [#2068](https://github.com/wallabag/wallabag/pull/2068), [#2049](https://github.com/wallabag/wallabag/pull/2049) Update documentation (Josh Panter, Mario Vormstein)
|
||||
|
||||
### Fixed
|
||||
|
||||
- [#2122](https://github.com/wallabag/wallabag/pull/2122) Fix the deletion of Tags/Entries relation when delete an entry (Jeremy Benoist, Nicolas Lœuillet)
|
||||
- [#2095](https://github.com/wallabag/wallabag/pull/2095) Fix form user display when 2FA is disabled (Nicolas Lœuillet)
|
||||
- [#2092](https://github.com/wallabag/wallabag/pull/2092) API: Starred and archived clears if article is already exists (Rurik19)
|
||||
- [#2097](https://github.com/wallabag/wallabag/issues/2097) Fix image path in 2-factor authentification email (Baptiste Mille-Mathias)
|
||||
- [#2069](https://github.com/wallabag/wallabag/pull/2069) Do not specify language in Firefox addon link (Merouane Atig)
|
||||
|
||||
## [2.0.4] - 2016-05-07
|
||||
|
||||
### Added
|
||||
|
||||
- [#2016](https://github.com/wallabag/wallabag/pull/2016) Big updates in [our documentation](http://doc.wallabag.org/en/master/) (Nicolas Lœuillet)
|
||||
- [#2028](https://github.com/wallabag/wallabag/pull/2028) Documentation about android application (Strubbl)
|
||||
- [#2019](https://github.com/wallabag/wallabag/pull/2019) Italian translation (Daniele Conca)
|
||||
- [#2011](https://github.com/wallabag/wallabag/pull/2011) Documentation about wallabag upgrade (biva)
|
||||
- [#1985](https://github.com/wallabag/wallabag/pull/1985) Documentation about rights access (FoxMaSk)
|
||||
- [#1969](https://github.com/wallabag/wallabag/pull/1969) Third resources for API in documentation (Nicolas Lœuillet)
|
||||
- [#1967](https://github.com/wallabag/wallabag/pull/1967) FAQ page in documentation (Nicolas Lœuillet)
|
||||
|
||||
### Changed
|
||||
|
||||
- [#1977](https://github.com/wallabag/wallabag/pull/1977) Spanish documentation (jami7)
|
||||
|
||||
### Fixed
|
||||
|
||||
- [#2023](https://github.com/wallabag/wallabag/pull/2023) Fix translation for validators (Nicolas Lœuillet)
|
||||
- [#2020](https://github.com/wallabag/wallabag/pull/2020) Fix number of entries in tag/list (Nicolas Lœuillet)
|
||||
- [#2022](https://github.com/wallabag/wallabag/pull/2022) Fix pagination bar on small devices (Nicolas Lœuillet)
|
||||
- [#2013](https://github.com/wallabag/wallabag/pull/2013) Fix tag listing (Nicolas Lœuillet)
|
||||
- [#1976](https://github.com/wallabag/wallabag/pull/1976) Fix filter reading time (Nicolas Lœuillet)
|
||||
- [#2005](https://github.com/wallabag/wallabag/pull/2005) Fix reading speed not defined when user was created via config page (Nicolas Lœuillet)
|
||||
- [#2010](https://github.com/wallabag/wallabag/pull/2010) Set the title via POST /api/entries (Nicolas Lœuillet)
|
||||
|
||||
## [2.0.3] - 2016-04-22
|
||||
|
||||
### Added
|
||||
|
||||
- [#1962](https://github.com/wallabag/wallabag/pull/1962) cURL examples in documentation about API (Dirk Deimeke)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Forgot `composer.lock` file in 2.0.2 release so some users may encounter `Fatal error: Out of memory` error during installation
|
||||
|
||||
## [2.0.2] - 2016-04-21
|
||||
|
||||
### Added
|
||||
|
||||
- [#1945](https://github.com/wallabag/wallabag/pull/1945) cURL examples in documentation about API (Dirk Deimeke)
|
||||
- [#1911](https://github.com/wallabag/wallabag/pull/1911) Add title hover on entry titles (Thomas Citharel)
|
||||
|
||||
### Changed
|
||||
|
||||
- [#1944](https://github.com/wallabag/wallabag/pull/1944), [#1953](https://github.com/wallabag/wallabag/pull/1953), [#1954](https://github.com/wallabag/wallabag/pull/1954) Due to branches renaming, update documentation and configuration (maxi62330, Nicolas Lœuillet)
|
||||
- [#1942](https://github.com/wallabag/wallabag/pull/1942) Optimize import (Nicolas Lœuillet)
|
||||
- [#1935](https://github.com/wallabag/wallabag/pull/1935) Update spanish translation (jami7)
|
||||
- [#1929](https://github.com/wallabag/wallabag/pull/1929) Change guid and link in RSS feeds to give original entry URL (Nicolas Lœuillet)
|
||||
- [#1918](https://github.com/wallabag/wallabag/pull/1918) Improve pagination when user has lot of entries (Nicolas Lœuillet)
|
||||
- [#1916](https://github.com/wallabag/wallabag/pull/1916) Change PHP arrays and move test parameters in a separated file (Jeremy Benoist)
|
||||
|
||||
### Fixed
|
||||
|
||||
- [#1957](https://github.com/wallabag/wallabag/pull/1957) Fix translation for `Go to your account` button (Nicolas Lœuillet)
|
||||
- [#1925](https://github.com/wallabag/wallabag/pull/1925) Redirect to homepage if refered is null (Nicolas Lœuillet)
|
||||
- [#1912](https://github.com/wallabag/wallabag/pull/1912) Fix 500 Internal Server Error -> "Setting piwik_enabled couldn't be found" (Jeremy Benoist)
|
||||
|
||||
## [2.0.1] - 2016-04-11
|
||||
### Added
|
||||
|
||||
- [Documentation about importing large file](http://doc.wallabag.org/en/v2/user/installation.html#installing-on-nginx) into nginx. (Nicolas Lœuillet)
|
||||
- [Documentation about wallabag API](http://doc.wallabag.org/en/v2/developer/api.html) (Nicolas Lœuillet)
|
||||
- [#1861](https://github.com/wallabag/wallabag/pull/1861) Round estimated time and add reading speed for Baggy (Nicolas Lœuillet)
|
||||
- [Documentation about wallabag v1 CLI import](http://doc.wallabag.org/en/v2/user/migration.html#import-via-command-line-interface-cli) (Nicolas Lœuillet)
|
||||
- [Add migrate link](http://doc.wallabag.org/en/v2/user/migration.html) in documentation (Nicolas Lœuillet)
|
||||
|
||||
### Changed
|
||||
|
||||
- [#1823](https://github.com/wallabag/wallabag/pull/1823) Persian translation (Masoud Abkenar)
|
||||
- [#1901](https://github.com/wallabag/wallabag/pull/1901) Spanish translation (Jeremy Benoist)
|
||||
- [#1879](https://github.com/wallabag/wallabag/pull/1879) Move tag form in Material theme (Nicolas Lœuillet)
|
||||
|
||||
### Fixed
|
||||
|
||||
- [#1903](https://github.com/wallabag/wallabag/pull/1903) Force server version to avoid connection error (Jeremy Benoist)
|
||||
- [#1887](https://github.com/wallabag/wallabag/pull/1887) Fix duplicate article when added via the bookmarklet (Nicolas Lœuillet)
|
||||
- [#1895](https://github.com/wallabag/wallabag/pull/1895) API: All the entries are fetched via GET /api/entries (Nicolas Lœuillet)
|
||||
- [#1898](https://github.com/wallabag/wallabag/pull/1898) Fix estimated reading time in material view #1893 (Nicolas Lœuillet)
|
||||
- [#1896](https://github.com/wallabag/wallabag/pull/1896) remove download_picture setting and manage show_printlink in material theme #1867 (Nicolas Lœuillet)
|
||||
- [#1894](https://github.com/wallabag/wallabag/pull/1894) Fix documentation link in developer page (Nicolas Lœuillet)
|
||||
- [#1891](https://github.com/wallabag/wallabag/pull/1891) Fix typo on configuration page (Nicolas Lœuillet)
|
||||
- [#1884](https://github.com/wallabag/wallabag/pull/1884) Change the installation method in issue template (Nicolas Lœuillet)
|
||||
- [#1844](https://github.com/wallabag/wallabag/pull/1844) Lock ocramius/proxy-manager (Jeremy Benoist)
|
||||
- [#1840](https://github.com/wallabag/wallabag/pull/1840) Fix Archive page title translation (Nicolas Lœuillet)
|
||||
- [#1801](https://github.com/wallabag/wallabag/pull/1804) Force user-agent for iansommerville.com (Jeremy Benoist)
|
||||
|
||||
### Removed
|
||||
|
||||
- [#1900](https://github.com/wallabag/wallabag/pull/1900) Remove empty portugese documentation (Nicolas Lœuillet)
|
||||
- [#1868](https://github.com/wallabag/wallabag/pull/1868) Remove keyboard shortcut and add tagging rule panel in baggy (Nicolas Lœuillet)
|
||||
- [#1824](https://github.com/wallabag/wallabag/pull/1824) Remove SMTP configuration environment overrides (Mathieu Bruyen)
|
||||
|
||||
## [2.0.0] - 2016-04-03
|
||||
### Added
|
||||
|
||||
* save an article, read it, favorite it, archive it. (Hopefully)
|
||||
* annotations: In each article you read, you can write annotations. ([read the doc](http://doc.wallabag.org/en/v2/user/annotations.html))
|
||||
* filter entries by reading time, domain name, creation date, status, etc.
|
||||
* assign tags to entries
|
||||
* edit article titles
|
||||
* a REST API ([you can have a look to the documentation](http://v2.wallabag.org/api/doc))
|
||||
* authorization via oAuth2
|
||||
* a new default theme, called `material`
|
||||
* RSS feeds (with ability to limit number of articles)
|
||||
* create a new account from the config page (for super admin only)
|
||||
* recover passwords from login page (you have to fill your email on config page)
|
||||
* picture preview, if available, is displayed for each entry
|
||||
* Public registration
|
||||
* migration from wallabag v1/v2 (based on JSON export) ([read the doc](http://doc.wallabag.org/en/v2/user/import.html))
|
||||
* migration from Pocket (it works, but we need to implement asynchronous import: if you have too many articles, it can fail) ([read the doc](http://doc.wallabag.org/en/v2/user/import.html))
|
||||
* exports in many formats (PDF, JSON, EPUB, MOBI, XML, CSV and TXT).
|
||||
* 2-Factor authentication via email ([read the doc](http://doc.wallabag.org/en/v2/user/configuration.html#two-factor-authentication))
|
||||
* Tagging rule: create a rule to automatically assign tags to entries! ([read the doc](http://doc.wallabag.org/en/v2/user/configuration.html#tagging-rules))
|
||||
* Occitan, German, French, Turkish, Persian, Romanian, Polish, Danish, Spanish and English translations
|
||||
* Quickstart for beginners (when you don't have any entries)
|
||||
* Internal settings for administrator (the account created during installation)
|
||||
* For 3rd apps developers, a developer page is available to create API token
|
||||
11
README.md
@ -1,5 +1,5 @@
|
||||
[](https://travis-ci.org/wallabag/wallabag)
|
||||
[](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=v2)
|
||||
[](https://travis-ci.org/wallabag/wallabag)
|
||||
[](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=v2)
|
||||
[](https://gitter.im/wallabag/wallabag)
|
||||
|
||||
# What is wallabag?
|
||||
@ -8,16 +8,15 @@ Click, save and read it when you can. It extracts content so that you can read i
|
||||
|
||||
More informations on our website: [wallabag.org](https://wallabag.org)
|
||||
|
||||
# Want to test the v2?
|
||||
Keep in mind it's an **unstable** branch, everything can be broken :)
|
||||
# Install wallabag
|
||||
|
||||
If you don't have it yet, please [install composer](https://getcomposer.org/download/).
|
||||
If you don't have it yet, please [install composer](https://getcomposer.org/download/) or be sure to use Composer 1.2 (`composer selfupdate` can help you about that).
|
||||
Then you can install wallabag by executing the following commands:
|
||||
|
||||
```
|
||||
git clone https://github.com/wallabag/wallabag.git
|
||||
cd wallabag
|
||||
git checkout 2.0.0-beta.2
|
||||
git checkout 2.0.6
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console wallabag:install --env=prod
|
||||
php bin/console server:run --env=prod
|
||||
|
||||
@ -22,19 +22,22 @@ class AppKernel extends Kernel
|
||||
new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
|
||||
new Nelmio\CorsBundle\NelmioCorsBundle(),
|
||||
new Liip\ThemeBundle\LiipThemeBundle(),
|
||||
new Wallabag\CoreBundle\WallabagCoreBundle(),
|
||||
new Wallabag\ApiBundle\WallabagApiBundle(),
|
||||
new Bazinga\Bundle\HateoasBundle\BazingaHateoasBundle(),
|
||||
new Lexik\Bundle\FormFilterBundle\LexikFormFilterBundle(),
|
||||
new FOS\OAuthServerBundle\FOSOAuthServerBundle(),
|
||||
new Wallabag\UserBundle\WallabagUserBundle(),
|
||||
new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
|
||||
new Scheb\TwoFactorBundle\SchebTwoFactorBundle(),
|
||||
new KPhoen\RulerZBundle\KPhoenRulerZBundle(),
|
||||
new Wallabag\ImportBundle\WallabagImportBundle(),
|
||||
new Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle(),
|
||||
new Craue\ConfigBundle\CraueConfigBundle(),
|
||||
new Lexik\Bundle\MaintenanceBundle\LexikMaintenanceBundle(),
|
||||
new WhiteOctober\PagerfantaBundle\WhiteOctoberPagerfantaBundle(),
|
||||
|
||||
// wallabag bundles
|
||||
new Wallabag\CoreBundle\WallabagCoreBundle(),
|
||||
new Wallabag\ApiBundle\WallabagApiBundle(),
|
||||
new Wallabag\UserBundle\WallabagUserBundle(),
|
||||
new Wallabag\ImportBundle\WallabagImportBundle(),
|
||||
new Wallabag\AnnotationBundle\WallabagAnnotationBundle(),
|
||||
];
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
download_pictures: Bilder auf den Server herunterladen
|
||||
carrot: Teilen zu Carrot aktivieren
|
||||
diaspora_url: Diaspora-URL, sofern der Service aktiviert ist
|
||||
export_epub: ePUB-Export aktivieren
|
||||
export_mobi: .mobi-Export aktivieren
|
||||
export_pdf: PDF-Export aktivieren
|
||||
export_csv: CSV-Export aktivieren
|
||||
export_json: JSON-Export aktivieren
|
||||
export_txt: TXT-Export aktivieren
|
||||
export_xml: XML-Export aktivieren
|
||||
pocket_consumer_key: Consumer-Key für Pocket, um Inhalte zu importieren (https://getpocket.com/developer/docs/authentication)
|
||||
shaarli_url: Shaarli-URL, sofern der Service aktiviert ist
|
||||
share_diaspora: Teilen zu Diaspora aktiveren
|
||||
share_mail: Teilen via E-Mail aktiveren
|
||||
share_shaarli: Teilen zu Shaarli aktiveren
|
||||
share_twitter: Teilen zu Twitter aktiveren
|
||||
show_printlink: Link anzeigen, um den Inhalt auszudrucken
|
||||
wallabag_support_url: Support-URL für wallabag
|
||||
wallabag_url: URL von *deiner* wallabag-Instanz
|
||||
entry: "Artikel"
|
||||
export: "Export"
|
||||
import: "Import"
|
||||
misc: "Verschiedenes"
|
||||
modify_settings: "Übernehmen"
|
||||
piwik_host: Host deiner Webseite in Piwik
|
||||
piwik_site_id: ID deiner Webseite in Piwik
|
||||
piwik_enabled: Piwik aktivieren
|
||||
demo_mode_enabled: "Test-Modus aktivieren? (nur für die öffentliche wallabag-Demo genutzt)"
|
||||
demo_mode_username: "Test-Benutzer"
|
||||
@ -1,6 +1,6 @@
|
||||
download_pictures: Descagar imagenes
|
||||
download_pictures: Descargar imágenes
|
||||
carrot: Activar compartir con Carrot
|
||||
diaspora_url: Diaspora URL, si el servicio esta activado
|
||||
diaspora_url: Diaspora URL, si el servicio está activado
|
||||
export_epub: Activar exportación a ePub
|
||||
export_mobi: Activar exportación a .mobi
|
||||
export_pdf: Activar exportación a PDF
|
||||
@ -14,7 +14,7 @@ share_diaspora: Activar compartir con Diaspora
|
||||
share_mail: Activar compartir con email
|
||||
share_shaarli: Activar compartir con Shaarli
|
||||
share_twitter: Activar compartir con Twitter
|
||||
show_printlink: Mostrar un link para imprimir contenido
|
||||
show_printlink: Mostrar un enlace para imprimir contenido
|
||||
wallabag_support_url: URL de soporte de wallabag
|
||||
wallabag_url: URL de *tu* instancia de wallabag
|
||||
entry: "artículo"
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
download_pictures: Scarica le immagini sul tuo server
|
||||
carrot: Abilita la condivisione con Carrot
|
||||
diaspora_url: Diaspora URL, se il servizio è abilitato
|
||||
export_epub: Abilita esportazione ePub
|
||||
export_mobi: Abilita esportazione .mobi
|
||||
export_pdf: Abilita esportazione PDF
|
||||
export_csv: Abilita esportazione CSV
|
||||
export_json: Abilita esportazione JSON
|
||||
export_txt: Abilita esportazione TXT
|
||||
export_xml: Abilita esportazione XML
|
||||
pocket_consumer_key: Consumer key per Pocket per importare i contenuti (https://getpocket.com/developer/docs/authentication)
|
||||
shaarli_url: Shaarli URL, se il servizio è abilitato
|
||||
share_diaspora: Abilita la condivisione con Diaspora
|
||||
share_mail: Abilita la condivisione per email
|
||||
share_shaarli: Abilita la condivisione con Shaarli
|
||||
share_twitter: Abilita la condivisione con Twitter
|
||||
show_printlink: Mostra un collegamento per stampare il contenuto
|
||||
wallabag_support_url: URL di supporto per wallabag
|
||||
wallabag_url: URL della *tua* installazione di wallabag
|
||||
entry: "contenuto"
|
||||
export: "esporta"
|
||||
import: "importa"
|
||||
misc: "misc"
|
||||
modify_settings: "applica"
|
||||
piwik_host: Host del tuo sito in Piwik
|
||||
piwik_site_id: ID del tuo sito in Piwik
|
||||
piwik_enabled: Abilita Piwik
|
||||
demo_mode_enabled: "Abilita modalità demo ? (usato solo per la demo pubblica di wallabag)"
|
||||
demo_mode_username: "Utente Demo"
|
||||
@ -0,0 +1,29 @@
|
||||
download_pictures: Telecargar los imatges sul servidor
|
||||
carrot: Activar lo partatge cap a Carrot
|
||||
diaspora_url: URL de Diaspora, se lo servici Diaspora es activat
|
||||
export_epub: Activar l'expòrt ePub
|
||||
export_mobi: Activar l'expòrt .mobi
|
||||
export_pdf: Activar l'expòrt PDF
|
||||
export_csv: Activar l'expòrt CSV
|
||||
export_json: Activar l'expòrt JSON
|
||||
export_txt: Activar l'expòrt TXT
|
||||
export_xml: Activar l'expòrt XML
|
||||
pocket_consumer_key: Clau d'autentificacion Pocket per importar las donadas (https://getpocket.com/developer/docs/authentication)
|
||||
shaarli_url: URL de Shaarli, se lo servici Shaarli es activat
|
||||
share_diaspora: Activar lo partatge cap a Diaspora
|
||||
share_mail: Activar lo partatge per corrièl
|
||||
share_shaarli: Activar lo partatge cap a Shaarli
|
||||
share_twitter: Activar lo partatge cap a Twitter
|
||||
show_printlink: Afichar un ligam per imprimir
|
||||
wallabag_support_url: URL d'assisténcia de wallabag
|
||||
wallabag_url: URL de *vòstra* instància de wallabag
|
||||
entry: "article"
|
||||
export: "expòrt"
|
||||
import: "impòrt"
|
||||
misc: "divèrs"
|
||||
modify_settings: "aplicar"
|
||||
piwik_host: URL de vòstre site dins Piwik
|
||||
piwik_site_id: ID de vòstre site dins Piwik
|
||||
piwik_enabled: Activar Piwik
|
||||
demo_mode_enabled: "Activar lo mode demostracion ? (utilizar solament per la demostracion publica de wallabag)"
|
||||
demo_mode_username: "Utilizaire de la demostracion"
|
||||
@ -0,0 +1,2 @@
|
||||
Login: "Anmelden"
|
||||
Enter your email address below and we'll send you password reset instructions.: "Tippe deine E-Mail-Adresse unten ein und wir senden dir die Anweisungen, wie du dein Kennwort zurücksetzen kannst."
|
||||
@ -0,0 +1,2 @@
|
||||
Login: "Se connectar"
|
||||
Enter your email address below and we'll send you password reset instructions.: "Picatz vòstra adreça de corrièl çai-jos, vos mandarem las instruccions per reïnicializar vòstre senhal."
|
||||
@ -0,0 +1,2 @@
|
||||
Login: "Logowanie"
|
||||
Enter your email address below and we'll send you password reset instructions.: "Wpisz poniżej swój adres email, abyśmy mogli wysłać ci instrukcję resetowania hasła."
|
||||
@ -1,2 +1,2 @@
|
||||
set :branch, 'v2'
|
||||
set :branch, 'master'
|
||||
set :deploy_to, '/var/www/v2.wallabag.org/web/'
|
||||
|
||||
@ -5,30 +5,32 @@ imports:
|
||||
|
||||
framework:
|
||||
#esi: ~
|
||||
translator: { fallback: "%locale%" }
|
||||
secret: "%secret%"
|
||||
translator:
|
||||
enabled: true
|
||||
fallback: "%locale%"
|
||||
secret: "%secret%"
|
||||
router:
|
||||
resource: "%kernel.root_dir%/config/routing.yml"
|
||||
strict_requirements: ~
|
||||
form: ~
|
||||
form: ~
|
||||
csrf_protection: ~
|
||||
validation: { enable_annotations: true }
|
||||
validation:
|
||||
enable_annotations: true
|
||||
templating:
|
||||
engines: ['twig']
|
||||
#assets_version: SomeVersionScheme
|
||||
default_locale: "%locale%"
|
||||
trusted_hosts: ~
|
||||
default_locale: "%locale%"
|
||||
trusted_hosts: ~
|
||||
trusted_proxies: ~
|
||||
session:
|
||||
# handler_id set to null will use default session handler from php.ini
|
||||
handler_id: session.handler.native_file
|
||||
save_path: "%kernel.root_dir%/../var/sessions/%kernel.environment%"
|
||||
fragments: ~
|
||||
handler_id: session.handler.native_file
|
||||
save_path: "%kernel.root_dir%/../var/sessions/%kernel.environment%"
|
||||
fragments: ~
|
||||
http_method_override: true
|
||||
assets: ~
|
||||
|
||||
wallabag_core:
|
||||
version: 2.0.0-beta.2
|
||||
version: 2.0.6
|
||||
paypal_url: "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9UBA65LG3FX9Y&lc=gb"
|
||||
languages:
|
||||
en: 'English'
|
||||
@ -40,10 +42,13 @@ wallabag_core:
|
||||
pl: 'Polish'
|
||||
da: 'Dansk'
|
||||
es: 'Español'
|
||||
oc: 'Occitan'
|
||||
it: 'Italiano'
|
||||
items_on_page: 12
|
||||
theme: material
|
||||
language: en
|
||||
rss_limit: 50
|
||||
reading_speed: 1
|
||||
|
||||
wallabag_import:
|
||||
allow_mimetypes: ['application/octet-stream', 'application/json', 'text/plain']
|
||||
@ -51,14 +56,14 @@ wallabag_import:
|
||||
|
||||
# Twig Configuration
|
||||
twig:
|
||||
debug: "%kernel.debug%"
|
||||
debug: "%kernel.debug%"
|
||||
strict_variables: "%kernel.debug%"
|
||||
form_themes:
|
||||
- "LexikFormFilterBundle:Form:form_div_layout.html.twig"
|
||||
|
||||
# Assetic Configuration
|
||||
assetic:
|
||||
debug: "%kernel.debug%"
|
||||
debug: "%kernel.debug%"
|
||||
use_controller: false
|
||||
bundles: [ ]
|
||||
#java: /usr/bin/java
|
||||
@ -72,14 +77,15 @@ assetic:
|
||||
# Doctrine Configuration
|
||||
doctrine:
|
||||
dbal:
|
||||
driver: "%database_driver%"
|
||||
driver: "%database_driver%"
|
||||
host: "%database_host%"
|
||||
port: "%database_port%"
|
||||
dbname: "%database_name%"
|
||||
user: "%database_user%"
|
||||
password: "%database_password%"
|
||||
charset: UTF8
|
||||
path: "%database_path%"
|
||||
charset: UTF8
|
||||
path: "%database_path%"
|
||||
server_version: 5.6
|
||||
|
||||
orm:
|
||||
auto_generate_proxy_classes: "%kernel.debug%"
|
||||
@ -104,10 +110,11 @@ doctrine_migrations:
|
||||
# Swiftmailer Configuration
|
||||
swiftmailer:
|
||||
transport: "%mailer_transport%"
|
||||
host: "%mailer_host%"
|
||||
username: "%mailer_user%"
|
||||
password: "%mailer_password%"
|
||||
spool: { type: memory }
|
||||
host: "%mailer_host%"
|
||||
username: "%mailer_user%"
|
||||
password: "%mailer_password%"
|
||||
spool:
|
||||
type: memory
|
||||
|
||||
fos_rest:
|
||||
param_fetcher_listener: true
|
||||
@ -165,17 +172,17 @@ liip_theme:
|
||||
|
||||
path_patterns:
|
||||
bundle_resource:
|
||||
- %%bundle_path%%/Resources/views/themes/%%current_theme%%/%%template%%
|
||||
- "%%bundle_path%%/Resources/views/themes/%%current_theme%%/%%template%%"
|
||||
|
||||
fos_user:
|
||||
db_driver: orm
|
||||
firewall_name: main
|
||||
firewall_name: secured_area
|
||||
user_class: Wallabag\UserBundle\Entity\User
|
||||
registration:
|
||||
confirmation:
|
||||
enabled: %fosuser_confirmation%
|
||||
enabled: "%fosuser_confirmation%"
|
||||
from_email:
|
||||
address: %from_email%
|
||||
address: "%from_email%"
|
||||
sender_name: wallabag
|
||||
fos_oauth_server:
|
||||
db_driver: orm
|
||||
@ -193,8 +200,8 @@ scheb_two_factor:
|
||||
cookie_lifetime: 2592000
|
||||
|
||||
email:
|
||||
enabled: %twofactor_auth%
|
||||
sender_email: %twofactor_sender%
|
||||
enabled: "%twofactor_auth%"
|
||||
sender_email: "%twofactor_sender%"
|
||||
digits: 6
|
||||
template: WallabagUserBundle:Authentication:form.html.twig
|
||||
mailer: wallabag_user.auth_code_mailer
|
||||
|
||||
@ -5,7 +5,8 @@ framework:
|
||||
router:
|
||||
resource: "%kernel.root_dir%/config/routing_dev.yml"
|
||||
strict_requirements: true
|
||||
profiler: { only_exceptions: false }
|
||||
profiler:
|
||||
only_exceptions: false
|
||||
|
||||
web_profiler:
|
||||
toolbar: true
|
||||
@ -14,19 +15,19 @@ web_profiler:
|
||||
monolog:
|
||||
handlers:
|
||||
main:
|
||||
type: stream
|
||||
path: "%kernel.logs_dir%/%kernel.environment%.log"
|
||||
level: debug
|
||||
channels: [!event]
|
||||
type: stream
|
||||
path: "%kernel.logs_dir%/%kernel.environment%.log"
|
||||
level: debug
|
||||
channels: ['!event']
|
||||
console:
|
||||
type: console
|
||||
type: console
|
||||
bubble: false
|
||||
verbosity_levels:
|
||||
VERBOSITY_VERBOSE: INFO
|
||||
VERBOSITY_VERY_VERBOSE: DEBUG
|
||||
channels: [!event, !doctrine]
|
||||
channels: ['!event', '!doctrine']
|
||||
console_very_verbose:
|
||||
type: console
|
||||
type: console
|
||||
bubble: false
|
||||
verbosity_levels:
|
||||
VERBOSITY_VERBOSE: NOTICE
|
||||
|
||||
@ -2,8 +2,8 @@ imports:
|
||||
- { resource: config.yml }
|
||||
|
||||
#framework:
|
||||
# validation:
|
||||
# cache: apc
|
||||
# cache:
|
||||
# system: cache.adapter.apcu
|
||||
|
||||
#doctrine:
|
||||
# orm:
|
||||
@ -14,12 +14,12 @@ imports:
|
||||
monolog:
|
||||
handlers:
|
||||
main:
|
||||
type: fingers_crossed
|
||||
type: fingers_crossed
|
||||
action_level: error
|
||||
handler: nested
|
||||
handler: nested
|
||||
nested:
|
||||
type: stream
|
||||
path: "%kernel.logs_dir%/%kernel.environment%.log"
|
||||
type: stream
|
||||
path: "%kernel.logs_dir%/%kernel.environment%.log"
|
||||
level: debug
|
||||
console:
|
||||
type: console
|
||||
type: console
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
imports:
|
||||
- { resource: config_dev.yml }
|
||||
- { resource: parameters_test.yml }
|
||||
|
||||
framework:
|
||||
test: ~
|
||||
@ -7,6 +8,8 @@ framework:
|
||||
storage_id: session.storage.mock_file
|
||||
profiler:
|
||||
collect: false
|
||||
translator:
|
||||
enabled: false
|
||||
|
||||
web_profiler:
|
||||
toolbar: false
|
||||
|
||||
@ -19,14 +19,6 @@ parameters:
|
||||
database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite"
|
||||
database_table_prefix: wallabag_
|
||||
|
||||
test_database_driver: pdo_sqlite
|
||||
test_database_host: 127.0.0.1
|
||||
test_database_port: ~
|
||||
test_database_name: ~
|
||||
test_database_user: ~
|
||||
test_database_password: ~
|
||||
test_database_path: "%kernel.root_dir%/../data/db/wallabag_test.sqlite"
|
||||
|
||||
mailer_transport: smtp
|
||||
mailer_host: 127.0.0.1
|
||||
mailer_user: ~
|
||||
|
||||
8
app/config/parameters_test.yml
Normal file
@ -0,0 +1,8 @@
|
||||
parameters:
|
||||
test_database_driver: pdo_sqlite
|
||||
test_database_host: 127.0.0.1
|
||||
test_database_port: null
|
||||
test_database_name: null
|
||||
test_database_user: null
|
||||
test_database_password: null
|
||||
test_database_path: '%kernel.root_dir%/../data/db/wallabag_testYO.sqlite'
|
||||
@ -4,8 +4,8 @@ wallabag_annotation:
|
||||
|
||||
wallabag_import:
|
||||
resource: "@WallabagImportBundle/Controller/"
|
||||
type: annotation
|
||||
prefix: /import
|
||||
type: annotation
|
||||
prefix: /import
|
||||
|
||||
wallabag_api:
|
||||
resource: "@WallabagApiBundle/Resources/config/routing.yml"
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
_wdt:
|
||||
resource: "@WebProfilerBundle/Resources/config/routing/wdt.xml"
|
||||
prefix: /_wdt
|
||||
prefix: /_wdt
|
||||
|
||||
_profiler:
|
||||
resource: "@WebProfilerBundle/Resources/config/routing/profiler.xml"
|
||||
prefix: /_profiler
|
||||
prefix: /_profiler
|
||||
|
||||
_errors:
|
||||
resource: "@TwigBundle/Resources/config/routing/errors.xml"
|
||||
prefix: /_error
|
||||
prefix: /_error
|
||||
|
||||
_main:
|
||||
resource: routing.yml
|
||||
|
||||
@ -3,12 +3,14 @@ security:
|
||||
FOS\UserBundle\Model\UserInterface: sha512
|
||||
|
||||
role_hierarchy:
|
||||
ROLE_ADMIN: ROLE_USER
|
||||
ROLE_ADMIN: ROLE_USER
|
||||
ROLE_SUPER_ADMIN: [ ROLE_USER, ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH ]
|
||||
|
||||
providers:
|
||||
administrators:
|
||||
entity: { class: WallabagUserBundle:User, property: username }
|
||||
entity:
|
||||
class: WallabagUserBundle:User
|
||||
property: username
|
||||
fos_userbundle:
|
||||
id: fos_user.user_provider.username
|
||||
|
||||
@ -31,7 +33,7 @@ security:
|
||||
anonymous: true
|
||||
|
||||
login_firewall:
|
||||
pattern: ^/login$
|
||||
pattern: ^/login$
|
||||
anonymous: ~
|
||||
|
||||
secured_area:
|
||||
@ -40,12 +42,12 @@ security:
|
||||
provider: fos_userbundle
|
||||
csrf_token_generator: security.csrf.token_manager
|
||||
|
||||
anonymous: true
|
||||
anonymous: true
|
||||
remember_me:
|
||||
secret: "%secret%"
|
||||
secret: "%secret%"
|
||||
lifetime: 31536000
|
||||
path: /
|
||||
domain: ~
|
||||
path: /
|
||||
domain: ~
|
||||
|
||||
logout:
|
||||
path: /logout
|
||||
|
||||
@ -6,7 +6,7 @@ services:
|
||||
filesystem_cache:
|
||||
class: Doctrine\Common\Cache\FilesystemCache
|
||||
arguments:
|
||||
- %kernel.cache_dir%/doctrine/metadata
|
||||
- "%kernel.cache_dir%/doctrine/metadata"
|
||||
|
||||
twig.extension.text:
|
||||
class: Twig_Extensions_Extension_Text
|
||||
|
||||
@ -1,37 +0,0 @@
|
||||
# This file is a "template" of what your parameters.yml file should look like
|
||||
parameters:
|
||||
database_driver: pdo_sqlite
|
||||
database_host: 127.0.0.1
|
||||
database_port: ~
|
||||
database_name: symfony
|
||||
database_user: root
|
||||
database_password: ~
|
||||
database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite"
|
||||
database_table_prefix: wallabag_
|
||||
|
||||
test_database_driver: pdo_mysql
|
||||
test_database_host: localhost
|
||||
test_database_port: 3306
|
||||
test_database_name: wallabag_test
|
||||
test_database_user: root
|
||||
test_database_password: ~
|
||||
test_database_path: ~
|
||||
|
||||
mailer_transport: smtp
|
||||
mailer_host: 127.0.0.1
|
||||
mailer_user: ~
|
||||
mailer_password: ~
|
||||
|
||||
locale: en
|
||||
|
||||
# A secret key that's used to generate certain security-related tokens
|
||||
secret: ThisTokenIsNotSoSecretChangeIt
|
||||
|
||||
# two factor stuff
|
||||
twofactor_auth: true
|
||||
twofactor_sender: no-reply@wallabag.org
|
||||
|
||||
# fosuser stuff
|
||||
fosuser_confirmation: true
|
||||
|
||||
from_email: no-reply@wallabag.org
|
||||
@ -1,37 +0,0 @@
|
||||
# This file is a "template" of what your parameters.yml file should look like
|
||||
parameters:
|
||||
database_driver: pdo_sqlite
|
||||
database_host: 127.0.0.1
|
||||
database_port: ~
|
||||
database_name: symfony
|
||||
database_user: root
|
||||
database_password: ~
|
||||
database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite"
|
||||
database_table_prefix: wallabag_
|
||||
|
||||
test_database_driver: pdo_pgsql
|
||||
test_database_host: localhost
|
||||
test_database_port:
|
||||
test_database_name: wallabag_test
|
||||
test_database_user: travis
|
||||
test_database_password: ~
|
||||
test_database_path: ~
|
||||
|
||||
mailer_transport: smtp
|
||||
mailer_host: 127.0.0.1
|
||||
mailer_user: ~
|
||||
mailer_password: ~
|
||||
|
||||
locale: en
|
||||
|
||||
# A secret key that's used to generate certain security-related tokens
|
||||
secret: ThisTokenIsNotSoSecretChangeIt
|
||||
|
||||
# two factor stuff
|
||||
twofactor_auth: true
|
||||
twofactor_sender: no-reply@wallabag.org
|
||||
|
||||
# fosuser stuff
|
||||
fosuser_confirmation: true
|
||||
|
||||
from_email: no-reply@wallabag.org
|
||||
@ -1,37 +0,0 @@
|
||||
# This file is a "template" of what your parameters.yml file should look like
|
||||
parameters:
|
||||
database_driver: pdo_sqlite
|
||||
database_host: 127.0.0.1
|
||||
database_port: ~
|
||||
database_name: symfony
|
||||
database_user: root
|
||||
database_password: ~
|
||||
database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite"
|
||||
database_table_prefix: wallabag_
|
||||
|
||||
test_database_driver: pdo_sqlite
|
||||
test_database_host: localhost
|
||||
test_database_port:
|
||||
test_database_name: ~
|
||||
test_database_user: ~
|
||||
test_database_password: ~
|
||||
test_database_path: "%kernel.root_dir%/../data/db/wallabag_test.sqlite"
|
||||
|
||||
mailer_transport: smtp
|
||||
mailer_host: 127.0.0.1
|
||||
mailer_user: ~
|
||||
mailer_password: ~
|
||||
|
||||
locale: en
|
||||
|
||||
# A secret key that's used to generate certain security-related tokens
|
||||
secret: ThisTokenIsNotSoSecretChangeIt
|
||||
|
||||
# two factor stuff
|
||||
twofactor_auth: true
|
||||
twofactor_sender: no-reply@wallabag.org
|
||||
|
||||
# fosuser stuff
|
||||
fosuser_confirmation: true
|
||||
|
||||
from_email: no-reply@wallabag.org
|
||||
8
app/config/tests/parameters_test.mysql.yml
Normal file
@ -0,0 +1,8 @@
|
||||
parameters:
|
||||
test_database_driver: pdo_mysql
|
||||
test_database_host: localhost
|
||||
test_database_port: 3306
|
||||
test_database_name: wallabag_test
|
||||
test_database_user: root
|
||||
test_database_password: ~
|
||||
test_database_path: ~
|
||||
8
app/config/tests/parameters_test.pgsql.yml
Normal file
@ -0,0 +1,8 @@
|
||||
parameters:
|
||||
test_database_driver: pdo_pgsql
|
||||
test_database_host: localhost
|
||||
test_database_port:
|
||||
test_database_name: wallabag_test
|
||||
test_database_user: travis
|
||||
test_database_password: ~
|
||||
test_database_path: ~
|
||||
8
app/config/tests/parameters_test.sqlite.yml
Normal file
@ -0,0 +1,8 @@
|
||||
parameters:
|
||||
test_database_driver: pdo_sqlite
|
||||
test_database_host: localhost
|
||||
test_database_port:
|
||||
test_database_name: ~
|
||||
test_database_user: ~
|
||||
test_database_password: ~
|
||||
test_database_path: "%kernel.root_dir%/../data/db/wallabag_testHU.sqlite"
|
||||
@ -1 +0,0 @@
|
||||
../vendor/doctrine/orm/bin/doctrine
|
||||
@ -1 +0,0 @@
|
||||
../vendor/doctrine/dbal/bin/doctrine-dbal
|
||||
@ -1 +0,0 @@
|
||||
../vendor/doctrine/migrations/bin/doctrine-migrations
|
||||
@ -1 +0,0 @@
|
||||
../vendor/doctrine/orm/bin/doctrine.php
|
||||
@ -1 +0,0 @@
|
||||
../vendor/phpunit/phpunit/phpunit
|
||||
@ -1 +0,0 @@
|
||||
../vendor/sensiolabs/security-checker/security-checker
|
||||
@ -13,7 +13,7 @@ echo '> PHP is using the following php.ini file:'.PHP_EOL;
|
||||
if ($iniPath) {
|
||||
echo_style('green', ' '.$iniPath);
|
||||
} else {
|
||||
echo_style('warning', ' WARNING: No configuration file (php.ini) used by PHP!');
|
||||
echo_style('yellow', ' WARNING: No configuration file (php.ini) used by PHP!');
|
||||
}
|
||||
|
||||
echo PHP_EOL.PHP_EOL;
|
||||
|
||||
12
build.xml
@ -42,8 +42,8 @@
|
||||
<target name="db_mysql" description="Run test for MySQL">
|
||||
<delete dir="${basedir}/app/config/parameters.yml"/>
|
||||
<exec executable="cp">
|
||||
<arg value="${basedir}/app/config/tests/parameters.yml.dist.mysql"/>
|
||||
<arg value="${basedir}/app/config/parameters.yml"/>
|
||||
<arg value="${basedir}/app/config/tests/parameters_test.mysql.yml"/>
|
||||
<arg value="${basedir}/app/config/parameters_test.yml"/>
|
||||
</exec>
|
||||
|
||||
<exec executable="php">
|
||||
@ -56,8 +56,8 @@
|
||||
<target name="db_sqlite" description="Run test for SQLite">
|
||||
<delete dir="${basedir}/app/config/parameters.yml"/>
|
||||
<exec executable="cp">
|
||||
<arg value="${basedir}/app/config/tests/parameters.yml.dist.sqlite"/>
|
||||
<arg value="${basedir}/app/config/parameters.yml"/>
|
||||
<arg value="${basedir}/app/config/tests/parameters_test.sqlite.yml"/>
|
||||
<arg value="${basedir}/app/config/parameters_test.yml"/>
|
||||
</exec>
|
||||
|
||||
<exec executable="php">
|
||||
@ -70,8 +70,8 @@
|
||||
<target name="db_pgsql" description="Run test for PostgreSQL">
|
||||
<delete dir="${basedir}/app/config/parameters.yml"/>
|
||||
<exec executable="cp">
|
||||
<arg value="${basedir}/app/config/tests/parameters.yml.dist.pgsql"/>
|
||||
<arg value="${basedir}/app/config/parameters.yml"/>
|
||||
<arg value="${basedir}/app/config/tests/parameters_test.pgsql.yml"/>
|
||||
<arg value="${basedir}/app/config/parameters_test.yml"/>
|
||||
</exec>
|
||||
|
||||
<exec executable="php">
|
||||
|
||||
@ -43,7 +43,7 @@
|
||||
"ext-iconv": "*",
|
||||
"ext-tokenizer": "*",
|
||||
"ext-pdo": "*",
|
||||
"symfony/symfony": "3.0.*",
|
||||
"symfony/symfony": "3.1.*",
|
||||
"doctrine/orm": "^2.5",
|
||||
"doctrine/doctrine-bundle": "^1.6",
|
||||
"doctrine/doctrine-cache-bundle": "^1.2",
|
||||
@ -58,7 +58,6 @@
|
||||
"friendsofsymfony/rest-bundle": "~1.4",
|
||||
"jms/serializer-bundle": "~1.0",
|
||||
"nelmio/api-doc-bundle": "~2.7",
|
||||
"ezyang/htmlpurifier": "~4.6",
|
||||
"mgargano/simplehtmldom": "~1.5",
|
||||
"tecnickcom/tcpdf": "~6.2",
|
||||
"simplepie/simplepie": "~1.3.1",
|
||||
@ -75,25 +74,26 @@
|
||||
"grandt/phpepub": "~4.0",
|
||||
"wallabag/php-mobi": "~1.0.0",
|
||||
"kphoen/rulerz-bundle": "~0.10",
|
||||
"guzzlehttp/guzzle": "^5.2.0",
|
||||
"guzzlehttp/guzzle": "^5.3.1",
|
||||
"doctrine/doctrine-migrations-bundle": "^1.0",
|
||||
"paragonie/random_compat": "~1.0",
|
||||
"craue/config-bundle": "~1.4",
|
||||
"mnapoli/piwik-twig-extension": "^1.0",
|
||||
"lexik/maintenance-bundle": "~2.1"
|
||||
"lexik/maintenance-bundle": "~2.1",
|
||||
"ocramius/proxy-manager": "1.*",
|
||||
"white-october/pagerfanta-bundle": "^1.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"doctrine/doctrine-fixtures-bundle": "~2.2",
|
||||
"doctrine/data-fixtures": "~1.1.1",
|
||||
"sensio/generator-bundle": "^3.0",
|
||||
"phpunit/phpunit": "~4.4",
|
||||
"symfony/phpunit-bridge": "^2.7"
|
||||
"symfony/phpunit-bridge": "^3.0",
|
||||
"friendsofphp/php-cs-fixer": "~1.9"
|
||||
},
|
||||
"scripts": {
|
||||
"build-parameters": [
|
||||
"Incenteev\\ParameterHandler\\ScriptHandler::buildParameters"
|
||||
],
|
||||
"post-cmd": [
|
||||
"@build-parameters",
|
||||
"Incenteev\\ParameterHandler\\ScriptHandler::buildParameters",
|
||||
"Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap",
|
||||
"Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache",
|
||||
"Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets",
|
||||
@ -115,19 +115,16 @@
|
||||
"symfony-tests-dir": "tests",
|
||||
"symfony-assets-install": "relative",
|
||||
"incenteev-parameters": {
|
||||
"file": "app/config/parameters.yml",
|
||||
"env-map": {
|
||||
"mailer_host": "WALLABAG_MAILER_HOST",
|
||||
"mailer_user": "WALLABAG_MAILER_USER",
|
||||
"mailer_password": "WALLABAG_MAILER_PASSWORD",
|
||||
"secret": "WALLABAG_SECRET"
|
||||
}
|
||||
"file": "app/config/parameters.yml"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": { "Wallabag\\": "src/Wallabag/" },
|
||||
"classmap": [ "app/AppKernel.php", "app/AppCache.php" ]
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": { "Tests\\": "tests/" }
|
||||
},
|
||||
"config": {
|
||||
"bin-dir": "bin"
|
||||
},
|
||||
|
||||
2005
composer.lock
generated
270
docs/de/developer/api.rst
Normal file
57
docs/de/developer/docker.rst
Normal file
@ -0,0 +1,57 @@
|
||||
Lasse wallabag in docker-compose laufen
|
||||
=======================================
|
||||
|
||||
Um deine eigene Entwicklungsinstanz von wallabag laufen zu lassen,
|
||||
möchtest du vielleicht die vorkonfigurierten docker compose Dateien
|
||||
nutzen.
|
||||
|
||||
Voraussetzungen
|
||||
---------------
|
||||
|
||||
Stelle sicher `Docker
|
||||
<https://docs.docker.com/installation/ubuntulinux/>`__ und `Docker
|
||||
Compose <https://docs.docker.com/compose/install/>`__ auf deinem
|
||||
System verfügbar und aktuell zu haben.
|
||||
|
||||
Wechsel des DBMS
|
||||
----------------
|
||||
|
||||
Standardmäßig startet wallabag mit einer SQLite Datenbank.
|
||||
Da wallabag Unterstützung für Postgresql und MySQL bietet, gibt es
|
||||
auch docker Container für diese.
|
||||
|
||||
In der ``docker-compose.yml`` kommentierst du für das gewählte DBMS
|
||||
aus:
|
||||
|
||||
- die Container Definition (``postgres`` oder ``mariadb`` root
|
||||
Level Block)
|
||||
- den Container Link in dem ``php`` Container
|
||||
- die Container Umgebungsdatei in dem ``php`` Container
|
||||
|
||||
Um mit Symfony Kommandos auf deinem Host auszuführen (wie z.B.
|
||||
``wallabag:install``), sollst du außerdem:
|
||||
|
||||
- die richtige Umgebungsdatei auf deiner Kommandozeile einlesen,
|
||||
sodass Variablen wie ``SYMFONY__ENV__DATABASE_HOST`` existieren
|
||||
- eine Zeile ``127.0.0.1 rdbms`` in deiner ``hosts`` Datei auf dem
|
||||
System erstellen
|
||||
|
||||
wallabag laufen lassen
|
||||
----------------------
|
||||
|
||||
#. Forke und klone das Projekt
|
||||
#. Bearbeite ``app/config/parameters.yml`` um ``database_*``
|
||||
Eigenschaften mit den kommentierten zu ersetzen (mit Werten
|
||||
mit ``env.`` Präfix)
|
||||
#. ``composer install`` die Projektabhängigkeiten
|
||||
#. ``php app/console wallabag:install``, um das Schema zu erstellen
|
||||
#. ``docker-compose up`` um die Container laufen zu lassen
|
||||
#. Schließlich öffne http://localhost:8080/, um dein frisch
|
||||
installiertes wallabag zu finden.
|
||||
|
||||
In den verschiedenen Schritten wirst du vielleicht in verschiendene
|
||||
Probleme laufen wie UNIX Berechtigungsprobleme, falschen Pfaden im
|
||||
generierten Cache, etc.…
|
||||
Operationen wie das Löschen der Cachedateien oder das Ändern der
|
||||
Dateibesitzer können öfter gebraucht werden, darum habe keine Angst
|
||||
sie anzupassen.
|
||||
10
docs/de/developer/documentation.rst
Normal file
@ -0,0 +1,10 @@
|
||||
Wirke an dieser Dokumentation mit
|
||||
=================================
|
||||
|
||||
Quellen der Dokumentation sind hier zu finden https://github.com/wallabag/wallabag/tree/master/docs
|
||||
|
||||
Wir nutzen `ReadTheDocs <https://readthedocs.org>`__, um sie zu generieren.
|
||||
|
||||
Seiten werden in `reStructuredText <https://de.wikipedia.org/wiki/ReStructuredText>`__ geschrieben. Du kannst Onlinetools wie http://rst.aaroniles.net/ oder http://rst.ninjs.org/ nutzen, um eine Vorschau deiner Artikel zu betrachten.
|
||||
|
||||
Wenn du eine neue Seite erstellst, vergiss nicht die `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/index.rst>`__ zu bearbeiten, um dort einen Link für die Seitenleiste hinzuzufügen.
|
||||
32
docs/de/developer/maintenance.rst
Normal file
@ -0,0 +1,32 @@
|
||||
Wartungsmodus
|
||||
=============
|
||||
|
||||
Wenn du längere Aufgaben auf deiner wallabag Instanz ausführen willst, kannst du den Wartungsmodus aktivieren.
|
||||
Keiner wird dann Zugang zu deiner Instanz haben.
|
||||
|
||||
Aktivieren des Wartungsmodus
|
||||
----------------------------
|
||||
|
||||
Um den Wartungsmodus zu aktivieren, führe folgendes Kommando aus:
|
||||
|
||||
::
|
||||
|
||||
bin/console lexik:maintenance:lock --no-interaction
|
||||
|
||||
Du kannst deine IP Adresse in ``app/config/config.yml`` setzen, wenn du Zugriff zu wallabag haben willst, auch wenn der Wartungsmodus aktiv ist. Zum Beispiel:
|
||||
|
||||
::
|
||||
|
||||
lexik_maintenance:
|
||||
authorized:
|
||||
ips: ['127.0.0.1']
|
||||
|
||||
|
||||
Deaktivieren des Wartungsmodus
|
||||
------------------------
|
||||
|
||||
Um den Wartungsmodus zu deaktivieren, führe dieses Kommando aus:
|
||||
|
||||
::
|
||||
|
||||
bin/console lexik:maintenance:unlock
|
||||
57
docs/de/developer/translate.rst
Normal file
@ -0,0 +1,57 @@
|
||||
Übersetze wallabag
|
||||
==================
|
||||
|
||||
wallabag Webapplikation
|
||||
-----------------------
|
||||
|
||||
Übersetzungsdateien
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. note::
|
||||
|
||||
Da wallabag hauptsächlich von einem französischem Team entwickelt wird, betrachte
|
||||
die französische Übersetzung als die aktuellste und kopiere sie, um deine eigene Übersetzung zu starten.
|
||||
|
||||
Du kannst die Übersetzungsdateien hier finden: https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations.
|
||||
|
||||
Du musst die ``messages.CODE.yml`` und ``validators.CODE.yml`` erstellen, wobei CODE
|
||||
der ISO 639-1 Code deiner Sprache ist (`siehe Wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__).
|
||||
|
||||
Andere Dateien zum Übersetzen:
|
||||
|
||||
- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations.
|
||||
- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations.
|
||||
|
||||
Du musst die ``THE_TRANSLATION_FILE.CODE.yml`` Dateien erstellen.
|
||||
|
||||
Konfigurationsdatei
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Du musst die `app/config/config.yml <https://github.com/wallabag/wallabag/blob/master/app/config/config.yml>`__ bearbeiten,
|
||||
um deine Sprache auf der Konfigurationsseite in wallabag anzuzeigen (um Nutzern zu erlauben zu dieser neuen Übersetzung zu wechseln).
|
||||
|
||||
Unter dem Abschnitt ``wallabag_core.languages`` musst du eine neue Zeile mit deiner Übersetzung hinzufügen. Zum Beispiel:
|
||||
|
||||
::
|
||||
|
||||
wallabag_core:
|
||||
...
|
||||
languages:
|
||||
en: 'English'
|
||||
fr: 'Français'
|
||||
|
||||
|
||||
Für die erste Spalte (``en``, ``fr``, etc.) musst du den ISO 639-1 Code deiner Sprache hinzufügen (siehe oben).
|
||||
|
||||
Für die zweite Spalte trägst du den Namen deiner Sprache ein. Nur den.
|
||||
|
||||
wallabag Dokumentation
|
||||
----------------------
|
||||
|
||||
.. note::
|
||||
|
||||
Im Gegensatz zur Webapplikation ist die Hauptsprache für die Dokumentation Englisch.
|
||||
|
||||
Documentationsdateien sind hier gespeichert: https://github.com/wallabag/wallabag/tree/master/docs
|
||||
|
||||
Du musst die Ordnerstruktur des Ordners ``en`` beachten, wenn du deine eigene Übersetzung startest.
|
||||
52
docs/de/index.rst
Normal file
@ -0,0 +1,52 @@
|
||||
wallabag Dokumentation
|
||||
======================
|
||||
|
||||
.. image:: ../img/wallabag.png
|
||||
:alt: wallabag Logo
|
||||
:align: center
|
||||
|
||||
**wallabag** ist eine Read-it-later Applikation: es speichert Websites,
|
||||
indem es nur den Inhalt behält. Elemente wie Navigation oder Werbung werden gelöscht.
|
||||
|
||||
.. tip::
|
||||
|
||||
Diese Dokumentation ist über wallabag v2. Wenn du die Dokumentation für wallabag v1 lesen willst, `siehe dir bitte das hier an <https://github.com/wallabag/documentation>`__.
|
||||
|
||||
Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organisiert:
|
||||
|
||||
* :ref:`user-docs`
|
||||
* :ref:`dev-docs`
|
||||
|
||||
.. _user-docs:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Nutzerdokumentation
|
||||
|
||||
user/faq
|
||||
user/installation
|
||||
user/upgrade
|
||||
user/migration
|
||||
user/import
|
||||
user/create_account
|
||||
user/login
|
||||
user/configuration
|
||||
user/first_article
|
||||
user/errors_during_fetching
|
||||
user/annotations
|
||||
user/download_articles
|
||||
user/filters
|
||||
user/tags
|
||||
user/android
|
||||
|
||||
.. _dev-docs:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Entwicklerdokumentation
|
||||
|
||||
developer/api
|
||||
developer/docker
|
||||
developer/documentation
|
||||
developer/translate
|
||||
developer/maintenance
|
||||
107
docs/de/user/android.rst
Normal file
@ -0,0 +1,107 @@
|
||||
Android App
|
||||
===========
|
||||
|
||||
|
||||
Zweck dieses Dokuments
|
||||
----------------------
|
||||
|
||||
Dieses Dokument beschreibt wie du deine Android App einrichtest, damit sie mit deiner Wallabaginstanz zusammenarbeitet. Es gibt hierbei keinen Unterschied im Vorgang - egal ob du Wallabag v1 oder v2 einsetzt.
|
||||
|
||||
|
||||
Schritte, um dein App zu einzurichten
|
||||
-------------------------------------
|
||||
|
||||
Wenn du das erste Mal die App startest, siehst du den Willkommensbildschirm, wo du angewiesen wirst zunächst deine App mit deiner Wallabaginstanz einzurichten.
|
||||
|
||||
.. image:: ../../img/user/android_welcome_screen.de.png
|
||||
:alt: Willkommensbildschirm
|
||||
:align: center
|
||||
|
||||
Bestätige nur diese Nachricht und du wirst zum Einstellungsbildschirm weitergeleitet.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_screen.de.png
|
||||
:alt: Einstellungsbildschirm
|
||||
:align: center
|
||||
|
||||
Trage deine Wallabagdaten ein. Du musst deine Wallabagadresse eintragen. Es ist wichtig, dass die URL nicht mit einem Schrägstrich endet. Füge auch deine Wallabagzugangsdaten in das Nutzer- und Passwortfeld ein.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_filled_in.de.png
|
||||
:alt: Eingetragene Einstellungen
|
||||
:align: center
|
||||
|
||||
Nachdem du deine Daten eingetragen hast, drücke den Button Verbindung testen und warte auf das Fertigstellen des Tests.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_connection_test.de.png
|
||||
:alt: Verbindungstest mit deinen Wallabagdaten
|
||||
:align: center
|
||||
|
||||
Der Verbindungstest sollte mit Erfolg ausgehen. Falls nicht, musst du zunächst deine Daten korrigieren bevor du zum nächsten Schritt gehst.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_connection_test_success.de.png
|
||||
:alt: Verbindungstest war erfolgreich
|
||||
:align: center
|
||||
|
||||
Nach dem Verbindungstest erfolgreich war, kannst du den Button zum Feedzugangsdaten abholen drücken. Die App versucht nun sich bei deiner Wallabaginstanz einzuloggen und die Nutzer ID und den dazugehörigen Token für die Feeds zu laden.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_get_feed_credentials.de.png
|
||||
:alt: Feedzugangsdaten abholen
|
||||
:align: center
|
||||
|
||||
Wenn der Prozess des Abholens deiner Feedzugangsdaten erfolgreich beendet wurde, siehst du eine Toastnachricht, dass die User ID und der Token automatisch in das Formular eingetragen wurden.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.de.png
|
||||
:alt: Feedzugangsdaten erfolgreich abgeholt
|
||||
:align: center
|
||||
|
||||
Jetzt scrollst du bis zum unteren Rand des Einstellungsbildschirms. Natürlich kannst du die Einstellungen dort deinen Wünschen anpassen. Schließe die Einrichtung mit dem Drücken des Speicherbuttons ab.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_scroll_bottom.de.png
|
||||
:alt: unterer Rand des Einstellungsbildschirms
|
||||
:align: center
|
||||
|
||||
Nachdem du den Speicherbutton gedrückt hast, kommst du in den folgenden Bildschirm. Die App schlägt vor, eine initiale Synchronisation der Artikelfeeds durchzuführen. Hier ist es empfohlen, dies zu bestätigen und Ja zu drücken.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_saved_feed_update.de.png
|
||||
:alt: Einstellung erstmals gespeichert
|
||||
:align: center
|
||||
|
||||
Schließlich nach der ersten erfolgreichen Synchronisation, wird dir die Liste der ungelesenen Artikel präsentiert.
|
||||
|
||||
.. image:: ../../img/user/android_unread_feed_synced.de.png
|
||||
:alt: Gefüllte Artikellist da Feeds erfolgreich synchronisiert sind
|
||||
:align: center
|
||||
|
||||
|
||||
|
||||
Bekannte Limitierungen
|
||||
---------------------
|
||||
|
||||
2FA
|
||||
~~~
|
||||
|
||||
Zur Zeit unterstützt die App keine Zwei-Faktor Authentifizierung. Du solltest sie deaktivieren damit die App funktioniert.
|
||||
|
||||
|
||||
Begrenzte Anzahl Artikel mit Wallabag v2
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
In deiner Wallabaginstanz kannst du einstellen, wie viele Artikel Teil deiner RSS Feeds sind. Diese Option existierte in Wallabag v1 nicht, wo immer alle Artikel Teil des Feeds waren. Also wenn du die Anzahl der Artikel, die in der App angezeigt werden sollen, größer einstellst als die Anzahl Artikel in deinem Feed, wirst du nur die Anzahl an Artikel deines Feeds sehen.
|
||||
|
||||
|
||||
SSL/TLS Verschlüsselung
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Wenn du deine Wallabaginstanz per HTTPS erreichen kannst, solltest du das so konfigurieren. Besonders dann, wenn deine HTTP URL nach HTTPS umleitet. Im Moment kann die App mit dieser Weiterleitung nicht korrekt umgehen.
|
||||
|
||||
|
||||
Referenzen
|
||||
----------
|
||||
|
||||
`Quellcode der Android Applikation <https://github.com/wallabag/android-app>`_
|
||||
|
||||
`Android Applikation auf F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
|
||||
|
||||
`Android Applikation auf Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
|
||||
|
||||
`Support Chat auf English <https://gitter.im/wallabag/wallabag>`_
|
||||
|
||||
24
docs/de/user/annotations.rst
Normal file
@ -0,0 +1,24 @@
|
||||
Anmerkungen
|
||||
===========
|
||||
|
||||
In jedem Artikel, den du liest, kannst du Anmerkungen hinzufügen. Es ist einfacher mit ein paar Bilder erklärt.
|
||||
|
||||
Wähle den Teil des Artikels aus, den du kommentieren willst und klicke auf den Bleistift:
|
||||
|
||||
.. image:: ../../img/user/annotations_1.png
|
||||
:alt: Wähle den Text
|
||||
:align: center
|
||||
|
||||
Schreibe deinen Kommentar:
|
||||
|
||||
.. image:: ../../img/user/annotations_2.png
|
||||
:alt: Schreibe deinen Kommentar
|
||||
:align: center
|
||||
|
||||
Der Text ist nun hervorgehoben und du kannst deine Anmerkung lesen, wenn du den Mauspfeil darüber fährst.
|
||||
|
||||
.. image:: ../../img/user/annotations_3.png
|
||||
:alt: lese deine Anmerkung
|
||||
:align: center
|
||||
|
||||
Du kannst so viele Anmerkungen erstellen wie du möchtest.
|
||||
119
docs/de/user/configuration.rst
Normal file
@ -0,0 +1,119 @@
|
||||
Konfiguration
|
||||
=============
|
||||
|
||||
Nun, da du eingeloggt bist, ist es Zeit, deinen Account so zu konfigurieren,
|
||||
wie du möchtest.
|
||||
|
||||
Klicke auf ``Konfiguration`` im Menü. Du hast fünf Karteireiter: ``Einstellungen``,
|
||||
``RSS``, ``Benutzer-Informationen``, ``Kennwort`` und ``Tagging-Regeln``.
|
||||
|
||||
Einstellungen
|
||||
-------------
|
||||
|
||||
Theme
|
||||
~~~~~
|
||||
|
||||
wallabag ist anpassbar. Du kannst dein bevorzugtes Theme hier auswählen. Du kannst
|
||||
auch ein neues erstellen, ein extra Kapitel wird dem gewidmet sein. Das Standardtheme
|
||||
ist ``Material``, es ist das Theme, dass in den Dokumentationsbildschirmfotos genutzt wird.
|
||||
|
||||
Artikel pro Seite
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
Du kannst die Anzahl der dargestellten Artikel pro Seite ändern.
|
||||
|
||||
Lesegeschwindigkeit
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
wallabag berechnet die Lesezeit für jeden Artikel. Du kannst hier definieren, dank dieser Liste, ob du
|
||||
ein schneller oder langsamer Leser bist. wallabag wird die Lesezeit für jeden Artikel neu berechnen.
|
||||
|
||||
Sprache
|
||||
~~~~~~~
|
||||
|
||||
Du kannst die Sprache von der wallabag Benutzeroberfläche ändern. Du musst die ausloggen, damit diese
|
||||
Änderung Wirkung zeigt.
|
||||
|
||||
RSS
|
||||
---
|
||||
|
||||
wallabag stellt RSS Feeds für jeden Artikelstatus bereit: ungelesen, Favoriten und Archiv.
|
||||
|
||||
Als erstes musst du einen persönlciehn Token erstellen: Klicke auf ``Token generieren``.
|
||||
Es ist möglich deinen Token zu ändern, indem du auf ``Token zurücksetzen`` klickst.
|
||||
|
||||
Jetzt hast du drei Links, einen für jeden Status: Füge sie in deinem liebsten Feedreader hinzu.
|
||||
|
||||
Du kannst auch definieren wie viele Artikel du in deinem RSS Feed (Standardwert: 50) haben willst.
|
||||
|
||||
Benutzer-Informationen
|
||||
----------------------
|
||||
|
||||
Du kannst deinen Namen ändern, deine E-Mail-Adresse und die Zwei-Faktor-Authentifizierung aktivieren.
|
||||
|
||||
Zwei-Faktor-Authentifizierung
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Die Zwei-Faktor-Authentifizierung (2FA) dient dem Identitätsnachweis eines Nutzers mittels der
|
||||
Kombination zweier verschiedener und insbesondere unabhängiger Komponenten (Faktoren).
|
||||
|
||||
https://de.wikipedia.org/wiki/Zwei-Faktor-Authentifizierung
|
||||
|
||||
Wenn du 2FA aktivierst, erhälst du jedes Mal, wenn du dich bei wallabag einloggen willst, einen Code per
|
||||
Mail. Du musst den Code in das folgende Formular eingeben.
|
||||
|
||||
.. image:: ../../img/user/2FA_form.png
|
||||
:alt: Zwei-Faktor-Authentifizierung
|
||||
:align: center
|
||||
|
||||
Wenn du nicht jedes Mal, wenn du dich einloggen willst, einen Code zugesendet bekommen möchtest, kannst du
|
||||
die Checkbox ``Ich bin an einem persönlichen Computer`` anhaken: wallabag wird sich an dich für 15 Tage
|
||||
erinnern.
|
||||
|
||||
Passwort
|
||||
--------
|
||||
|
||||
Du kannst dein Passwort hier ändern (8 Zeichen Minimum).
|
||||
|
||||
Tagging-Regeln
|
||||
--------------
|
||||
|
||||
Wenn du automatisch einen Tag zu einem neuen Artikel zuweisen lassen möchtest, ist dieser Teil der
|
||||
Konfiguration, was du suchst.
|
||||
|
||||
Was ist mit Tagging-Regeln gemeint?
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Dies sind Regeln, die von wallabag genutzt werden, um neue Artikel automatisch zu taggen
|
||||
Jedes Mal, wenn ein neuer Artikel hinzugefügt wird, werden alle Tagging-Regeln genutzt, um deine
|
||||
konfigurierten Tags hinzuzufügen, folglich um dir den Aufwand zu sparen, die Artikel manuell einzuteilen.
|
||||
|
||||
Wie benutze ich sie?
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Nehmen wir an, du möchtest neuen Artikeln einen Tag *schnell gelesen*, wenn du die Lesezeit kleiner als
|
||||
3 Minuten ist.
|
||||
In diesem Fall solltest du in das Regelfeld "readingTime <= 3" eintragen und *schnell gelesen* in das Tags-Feld.
|
||||
Mehrere Tags können gleichzeitig hinzugefügt werden, wenn man sie mit einem Komma trennt:
|
||||
*schnell gelesen, Pflichtlektüre*.
|
||||
Komplexe Regeln können mit vordefinierten Operatoren geschrieben werden:
|
||||
Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu lesen, github*.
|
||||
|
||||
Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen?
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen:
|
||||
|
||||
=========== ============================================== ======== ==========
|
||||
Variable Bedeutung Operator Bedeutung
|
||||
----------- ---------------------------------------------- -------- ----------
|
||||
title Titel des Artikels <= Kleiner gleich als…
|
||||
url URL des Artikels < Kleiner als…
|
||||
isArchived Ob der Artikel archiviert ist oder nicht => Größer gleich als…
|
||||
isStarred Ob der Artikel favorisiert ist oder nicht > Größer als…
|
||||
content Inhalt des Eintrags = Gleich zu…
|
||||
language Sprache des Eintrags != Nicht gleich zu…
|
||||
mimetype MIME-Typ des Eintrags OR Eine Regel oder die andere
|
||||
readingTime Die geschätzte Lesezeit in Minuten AND Eine Regel und die andere
|
||||
domainName Der Domain-Name des Eintrags matches Testet, dass ein Feld einer Suche (unabhängig von Groß- und Kleinschreibung) übereinstimmt. Z.B.: title matches "Fußball"
|
||||
=========== ============================================== ======== ==========
|
||||
25
docs/de/user/create_account.rst
Normal file
@ -0,0 +1,25 @@
|
||||
Account erstellen
|
||||
=================
|
||||
|
||||
Klicke auf der Loginseite auf den ``Registrieren`` Button-
|
||||
|
||||
.. image:: ../../img/user/registration_form.png
|
||||
:alt: Registrierungsformular
|
||||
:align: center
|
||||
|
||||
Du musst das Formular ausfüllen. Bitte stelle sicher, dass du eine gültige
|
||||
E-Mail-Adresse eingibst, wir werden dir eine Aktivierungsmail schicken.
|
||||
|
||||
.. image:: ../../img/user/sent_email.png
|
||||
:alt: E-Mail wurde gesendet, um Account zu aktivieren
|
||||
:align: center
|
||||
|
||||
Überprüfge deinen Posteingang, du hast jetzt eine neue Mail mit einem Link wie diesen
|
||||
``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``.
|
||||
Klicke auf den Link, um deinen Account zu aktivieren.
|
||||
|
||||
Dein Account ist nun aktiviert.
|
||||
|
||||
.. image:: ../../img/user/activated_account.png
|
||||
:alt: Willkommen!
|
||||
:align: center
|
||||
17
docs/de/user/download_articles.rst
Normal file
@ -0,0 +1,17 @@
|
||||
Artikel herunterladen
|
||||
=====================
|
||||
|
||||
Du kannst jeden Artikel in verschiedenen Formaten herunterladen: ePUB, MOBI, PDF, XML, JSON, CSV.
|
||||
|
||||
In der Artikelansicht, klickst du auf dieses Icon in der Seitenleiste:
|
||||
|
||||
.. image:: ../../img/user/download_article.png
|
||||
:alt: Artikel herunterladen
|
||||
:align: center
|
||||
|
||||
Du kannst auch eine ganze Kategorie (ungelesen, Favoriten, Archiv) in diesen Formaten herunterladen.
|
||||
Zum Beispiel, in der Ansicht **Ungelesen**, klickst du auf das Icon in der oberen Leiste:
|
||||
|
||||
.. image:: ../../img/user/download_articles.png
|
||||
:alt: Artikel herunterladen
|
||||
:align: center
|
||||
28
docs/de/user/errors_during_fetching.rst
Normal file
@ -0,0 +1,28 @@
|
||||
Fehler während des Artikelladens
|
||||
================================
|
||||
|
||||
Warum schlägt das Laden eines Artikels fehl?
|
||||
--------------------------------------------
|
||||
|
||||
Das kann verschiedene Ursachen haben:
|
||||
|
||||
- Netzwerkprobleme
|
||||
- wallabag kann den Inhalt aufgrund der Websitestruktur nicht laden
|
||||
|
||||
Wie kann ich helfen das zu beheben?
|
||||
-----------------------------------
|
||||
|
||||
- `indem du uns eine Mail mit der URL des Artikels sendest <mailto:hello\@wallabag.org>`_
|
||||
- indem du versuchst das Laden des Artikels durch Erstellen einer Datei für den Artikel
|
||||
selbst zu beheben
|
||||
Du kannst `dieses Tool <http://siteconfig.fivefilters.org/>`__ nutzen.
|
||||
|
||||
Wie kann ich versuchen, einen Artikel erneut zu laden?
|
||||
------------------------------------------------------
|
||||
|
||||
Wenn wallabag beim Laden eines Artikels fehlschlägt, kannst du auf den erneut laden Button
|
||||
klicken (der dritte in dem unteren Bild).
|
||||
|
||||
.. image:: ../../img/user/refetch.png
|
||||
:alt: Inhalt neu laden
|
||||
:align: center
|
||||
45
docs/de/user/faq.rst
Normal file
@ -0,0 +1,45 @@
|
||||
Häufig gestellte Fragen
|
||||
==========================
|
||||
|
||||
Während der Installation sehe ich den Fehler ``Error Output: sh: 1: @post-cmd: not found``
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
Es scheint, dass du ein Problem bei deiner ``composer`` Installation hast. Versuche es zu deinstallieren und neu zu installieren.
|
||||
|
||||
`Lies die Dokumentation über composer, um zu erfahren wie es installiert wird
|
||||
<https://getcomposer.org/doc/00-intro.md>`__.
|
||||
|
||||
Ich kann das Registrierungsformular nicht validieren
|
||||
----------------------------------------------------
|
||||
|
||||
Stelle sicher, dass alle Felder ausgefüllt sind:
|
||||
|
||||
* valide E-Mail-Adresse
|
||||
* das gleiche Passwort in zwei Feldern
|
||||
|
||||
Ich erhalte meine Aktivierungsmail nicht
|
||||
----------------------------------------
|
||||
|
||||
Bist du sicher, dass deine eingegebene E-Mail-Adresse korrekt war? Hast du deinen Spamordner überprüft?
|
||||
|
||||
Wenn du dann immer noch nicht deine Aktivierungsmail siehst, stelle bitte sicher, dass du einen MTA
|
||||
korrekt installiert und eingerichtet hast. Prüfe, dass deine Firewallregel existiert, z.B. für firewalld:
|
||||
|
||||
::
|
||||
firewall-cmd --permanent --add-service=smtp
|
||||
firewall-cmd --reload
|
||||
|
||||
Schließlich, falls du SELinux aktiviert hast, setze folgende Regel:
|
||||
|
||||
``setsebool -P httpd_can_sendmail 1``
|
||||
|
||||
Wenn ich den Aktivierungslink klicke, bekomme ich die Nachricht ``Der Nutzer mit dem Bestätigungstoken "DtrOPfbQeVkWf6N" existiert nicht``
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Du hast deinen Account schon aktiviert oder die URL der Aktivierungsmail ist falsch.
|
||||
|
||||
Ich habe mein Passwort vergessen
|
||||
--------------------------------
|
||||
|
||||
Du kannst dein Passwort zurücksetzen, indem du auf den Link ``Kennwort vergessen?`` auf der Loginseite klickst. Fülle dann das Formular mit deiner E-Mail-Adresse oder deinem Nutzernamen aus
|
||||
und du wirst eine E-Mail zum Passwort zurücksetzen erhalten.
|
||||
49
docs/de/user/filters.rst
Normal file
@ -0,0 +1,49 @@
|
||||
Filter
|
||||
======
|
||||
|
||||
Um Artikel leichter zu erreichen, kannst du sie filtern.
|
||||
Klicke auf das dritte Symbol in der oberen Leiste.
|
||||
|
||||
.. image:: ../../img/user/topbar.png
|
||||
:alt: Obere Leiste
|
||||
:align: center
|
||||
|
||||
Alle diese Filter können kombiniert werden.
|
||||
|
||||
.. image:: ../../img/user/filters.png
|
||||
:alt: Kombiniere alle Filter
|
||||
:align: center
|
||||
|
||||
Status
|
||||
------
|
||||
|
||||
Nutze die Checkboxen, um einen archivierten oder favorisierten Artikel zu finden.
|
||||
|
||||
Vorschaubild
|
||||
---------------
|
||||
|
||||
Hake diesen Filter an, wenn du Artikel mit einem Vorschaubild erhalten willst.
|
||||
|
||||
Sprache
|
||||
-------
|
||||
|
||||
wallabag (via graby) kann die Artikelsprache erkennen. Es ist einfach für dich, Artikel
|
||||
in einer bestimmten Sprache zu filtern.
|
||||
|
||||
Lesezeit
|
||||
--------
|
||||
|
||||
wallabag schätzt wieviel Zeit du brauchst, um einen Artikel zu lesen. Mit diesem Filter
|
||||
kannst du zum Beispiel Artikel mit einer Lesezeit zwischen 2 und 5 Minuten finden.
|
||||
|
||||
Domainname
|
||||
----------
|
||||
|
||||
Dank dieses Filters, kannst ud Artikel von der gleichen Domain finden.
|
||||
Zum Beispiel tippst du in diesem Feld ``bbc.co.uk``, um Artikel dieser Website zu finden.
|
||||
|
||||
Erstellungsdatum
|
||||
----------------
|
||||
|
||||
Wenn du Artikel speicherst, merkt sich wallabag das aktuelle Datum. So praktisch, um Aritkel, die
|
||||
zwischen dem 1. und 31. Januar geschrieben sind, zu finden.
|
||||
68
docs/de/user/first_article.rst
Normal file
@ -0,0 +1,68 @@
|
||||
Speichere deinen ersten Artikel
|
||||
===============================
|
||||
|
||||
Der Hauptzweck von wallabag ist es Webartikel zu speichern. Du hast viele Wege das zu tun.
|
||||
|
||||
.. note::
|
||||
|
||||
Eine Schnellstartanleitung wird in der Anwendung angezeigt bis du deinen ersten
|
||||
Artikel gespeichert hast.
|
||||
|
||||
Durch Nutzung eines Bookmarklets
|
||||
--------------------------------
|
||||
|
||||
Auf der ``How-To`` Seite, hast du einen Reiter ``Bookmarklet``. Ziehe und lasse den
|
||||
``bag it!`` Link in die Lesezeichenleiste deines Browser los.
|
||||
|
||||
Jetzt kannst du immer wenn du einen Artikel im Web liest und ihn du ihn speichern
|
||||
willst, klicke auf den ``bag it!`` Link in deiner Lesezeichenleiste. Der Artikel
|
||||
wird gespeichert.
|
||||
|
||||
Durch Nutzung des klassischen Formulars
|
||||
---------------------------------------
|
||||
|
||||
In der oberen Leiste auf deinem Bildschirm, hast du drei Icons. Mit dem ersten, einem
|
||||
Pluszeichen, kannst du einfach neue Artikel speichern.
|
||||
|
||||
.. image:: ../../img/user/topbar.png
|
||||
:alt: obere Leiste
|
||||
:align: center
|
||||
|
||||
Klick darauf, um ein neues Feld anzeigen zu lassen, füge deine Artikel URL ein und
|
||||
drücke die ``Enter`` Taste. Der Artikel wird gespeichert.
|
||||
|
||||
Durch Nutzung eines Browser Add-ons
|
||||
-----------------------------------
|
||||
|
||||
Firefox
|
||||
~~~~~~~
|
||||
|
||||
*Dieses Addon ist noch nicht für wallbag v2 verfügbar*.
|
||||
|
||||
Chrome
|
||||
~~~~~~
|
||||
|
||||
*Dieses Addon ist noch nicht für wallbag v2 verfügbar*.
|
||||
|
||||
Durch Nutzung deiner Smartphone App
|
||||
-----------------------------------
|
||||
|
||||
Android
|
||||
~~~~~~~
|
||||
|
||||
*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
|
||||
|
||||
Firefox OS
|
||||
~~~~~~~~~~
|
||||
|
||||
*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
|
||||
|
||||
Windows Phone
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
|
||||
|
||||
iOS
|
||||
~~~
|
||||
|
||||
*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
|
||||
46
docs/de/user/import.rst
Normal file
@ -0,0 +1,46 @@
|
||||
Migration von einem Drittanbieter
|
||||
=================================
|
||||
|
||||
Von Pocket
|
||||
-----------
|
||||
|
||||
Erstelle eine neue Applikation in Pocket
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Um deine Daten von Pocket zu importieren, nutzen wir die Pocket API. Du musst
|
||||
eine neue Applikation auf ihrer Entwicklerwebsite erstellen, um fortzufahren.
|
||||
|
||||
* Erstelle eine neue Applikation `auf der Entwicklerwebsite <https://getpocket.com/developer/apps/new>`_
|
||||
* Fülle die erforderlichen Felder aus: Name, Beschreibung, Berechtigungen (nur **abrufen**), Plattform
|
||||
(**web**), akzeptiere die Nutzungsbedingungen und reiche deine neue Applikation ein
|
||||
|
||||
Pocket wird dir einen **Consumer Key** geben (z.B. `49961-985e4b92fe21fe4c78d682c1`).
|
||||
Du musst den ``pocket_consumer_key`` in dem Abschnitt ``Import`` in dem ``Interne Einstellungen`` Menü
|
||||
konfigurieren.
|
||||
|
||||
Jetzt ist alles in Ordnung, um von Pocket zu migrieren.
|
||||
|
||||
Importiere deine Daten in wallabag 2.x
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Klicke auf den ``Importieren`` Link im menü, auf ``Inhalte importieren`` in dem Pocketabschnitt und
|
||||
dann auf ``Verbinde mit Pocket und importieren Daten``.
|
||||
|
||||
Du musst wallabag erlauben, mit deinem Pocketaccount zu interagieren.
|
||||
Deine Daten werden importiert. Datenimport kann ein sehr anspruchsvoller Prozess für deinen Server
|
||||
sein (wir müssen daran arbeiten, um diesen Import zu verbessern).
|
||||
|
||||
Von Instapaper
|
||||
--------------
|
||||
|
||||
*Funktion noch nicht implementiert in wallabag v2.*
|
||||
|
||||
Von Readability
|
||||
---------------
|
||||
|
||||
*Funktion noch nicht implementiert in wallabag v2.*
|
||||
|
||||
Von einer HTML oder JSON Datei
|
||||
------------------------------
|
||||
|
||||
*Funktion noch nicht implementiert in wallabag v2.*
|
||||
326
docs/de/user/installation.rst
Normal file
@ -0,0 +1,326 @@
|
||||
Installation von wallabag
|
||||
=========================
|
||||
|
||||
Voraussetzungen
|
||||
---------------
|
||||
|
||||
wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.
|
||||
|
||||
Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell
|
||||
nicht alle folgenden Pakete installieren.
|
||||
|
||||
- php-session
|
||||
- php-ctype
|
||||
- php-dom
|
||||
- php-hash
|
||||
- php-simplexml
|
||||
- php-json
|
||||
- php-gd
|
||||
- php-mbstring
|
||||
- php-xml
|
||||
- php-tidy
|
||||
- php-iconv
|
||||
- php-curl
|
||||
- php-gettext
|
||||
- php-tokenizer
|
||||
|
||||
wallabag nutzt PDO, um sich mit der Datenbank zu verbinden, darum benötigst du eines der folgenden Komponenten:
|
||||
|
||||
- pdo_mysql
|
||||
- pdo_sqlite
|
||||
- pdo_pgsql
|
||||
|
||||
und dessen dazugehörigen Datenbankserver.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Auf einem dedizierten Webserver (empfohlener Weg)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast.
|
||||
|
||||
Composer installieren:
|
||||
|
||||
::
|
||||
|
||||
curl -s http://getcomposer.org/installer | php
|
||||
|
||||
Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden:
|
||||
|
||||
Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
|
||||
|
||||
::
|
||||
|
||||
git clone https://github.com/wallabag/wallabag.git
|
||||
cd wallabag
|
||||
git checkout 2.0.6
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console wallabag:install --env=prod
|
||||
|
||||
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
|
||||
|
||||
Und wallabag unter http://deineserverip:8000 erreichen
|
||||
|
||||
.. tip::
|
||||
|
||||
Um Parameter mit Umgebungsvariable zu definieren, musst du die Variable mit dem ``SYMFONY__`` Präfix setzen. Zum Beispiel ``SYMFONY__DATABASE_DRIVER``. Du kannst einen Blick die `Symfony Dokumentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ werfen.
|
||||
|
||||
Auf einem geteilten Webhosting
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Wir stellen ein Paket inkl. aller Abhängigkeiten bereit.
|
||||
Die Standardkonfiguration nutzt SQLite für die Datenbank. Wenn du diese Einstellung ändern willst, ändere bitte ``app/config/parameters.yml``.
|
||||
|
||||
Wir haben bereits einen Nutzer erstellt: Login und Passwort sind ``wallabag``.
|
||||
|
||||
.. caution:: Mit diesem Paket überprüft wallabag nicht die von der Applikation gebrauchten Exentions (diese Tests werden während ``composer install`` durchgeführt wenn du einen dedizierten Webserver hast, siehe oben).
|
||||
|
||||
Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacken:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
|
||||
Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu.
|
||||
Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``.
|
||||
|
||||
Installation mit Docker
|
||||
------------------------
|
||||
|
||||
Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__, um mehr Informationen zu erhalten.
|
||||
|
||||
Kommando, um den Container zu starten
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker pull wallabag/wallabag
|
||||
|
||||
Virtualhosts
|
||||
------------
|
||||
|
||||
Konfiguration von Apache
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren und du willst PHP als Apache Modul nutzen, dann ist hier ein vhost für wallabag:
|
||||
|
||||
::
|
||||
|
||||
<VirtualHost *:80>
|
||||
ServerName domain.tld
|
||||
ServerAlias www.domain.tld
|
||||
|
||||
DocumentRoot /var/www/wallabag/web
|
||||
<Directory /var/www/wallabag/web>
|
||||
AllowOverride None
|
||||
Order Allow,Deny
|
||||
Allow from All
|
||||
|
||||
<IfModule mod_rewrite.c>
|
||||
Options -MultiViews
|
||||
RewriteEngine On
|
||||
RewriteCond %{REQUEST_FILENAME} !-f
|
||||
RewriteRule ^(.*)$ app.php [QSA,L]
|
||||
</IfModule>
|
||||
</Directory>
|
||||
|
||||
# uncomment the following lines if you install assets as symlinks
|
||||
# or run into problems when compiling LESS/Sass/CoffeScript assets
|
||||
# <Directory /var/www/wallabag>
|
||||
# Options FollowSymlinks
|
||||
# </Directory>
|
||||
|
||||
# optionally disable the RewriteEngine for the asset directories
|
||||
# which will allow apache to simply reply with a 404 when files are
|
||||
# not found instead of passing the request into the full symfony stack
|
||||
<Directory /var/www/wallabag/web/bundles>
|
||||
<IfModule mod_rewrite.c>
|
||||
RewriteEngine Off
|
||||
</IfModule>
|
||||
</Directory>
|
||||
ErrorLog /var/log/apache2/wallabag_error.log
|
||||
CustomLog /var/log/apache2/wallabag_access.log combined
|
||||
</VirtualHost>
|
||||
|
||||
Nach dem du Apache neugeladen oder neugestartet hast, solltest du nun wallabag unter http://domain.tld erreichen.
|
||||
|
||||
Konfiguration von Nginx
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag:
|
||||
|
||||
::
|
||||
|
||||
server {
|
||||
server_name domain.tld www.domain.tld;
|
||||
root /var/www/wallabag/web;
|
||||
|
||||
location / {
|
||||
# try to serve file directly, fallback to app.php
|
||||
try_files $uri /app.php$is_args$args;
|
||||
}
|
||||
location ~ ^/app\.php(/|$) {
|
||||
fastcgi_pass unix:/var/run/php5-fpm.sock;
|
||||
fastcgi_split_path_info ^(.+\.php)(/.*)$;
|
||||
include fastcgi_params;
|
||||
# When you are using symlinks to link the document root to the
|
||||
# current version of your application, you should pass the real
|
||||
# application path instead of the path to the symlink to PHP
|
||||
# FPM.
|
||||
# Otherwise, PHP's OPcache may not properly detect changes to
|
||||
# your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
|
||||
# for more information).
|
||||
fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
|
||||
fastcgi_param DOCUMENT_ROOT $realpath_root;
|
||||
# Prevents URIs that include the front controller. This will 404:
|
||||
# http://domain.tld/app.php/some-path
|
||||
# Remove the internal directive to allow URIs like this
|
||||
internal;
|
||||
}
|
||||
|
||||
error_log /var/log/nginx/wallabag_error.log;
|
||||
access_log /var/log/nginx/wallabag_access.log;
|
||||
}
|
||||
|
||||
Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http://domain.tld erreichen.
|
||||
|
||||
.. tip::
|
||||
|
||||
When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``.
|
||||
Wenn du eine große Datei in wallabag importieren willst, solltest du diese Zeile zu deiner nginx Konfiguration hinzufügen ``client_max_body_size XM; # allows file uploads up to X megabytes``.
|
||||
|
||||
Konfiguration von lighttpd
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag (bearbeite deine ``lighttpd.conf`` und füge die Konfiguration dort ein):
|
||||
|
||||
::
|
||||
|
||||
server.modules = (
|
||||
"mod_fastcgi",
|
||||
"mod_access",
|
||||
"mod_alias",
|
||||
"mod_compress",
|
||||
"mod_redirect",
|
||||
"mod_rewrite",
|
||||
)
|
||||
server.document-root = "/var/www/wallabag/web"
|
||||
server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
|
||||
server.errorlog = "/var/log/lighttpd/error.log"
|
||||
server.pid-file = "/var/run/lighttpd.pid"
|
||||
server.username = "www-data"
|
||||
server.groupname = "www-data"
|
||||
server.port = 80
|
||||
server.follow-symlink = "enable"
|
||||
index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
|
||||
url.access-deny = ( "~", ".inc" )
|
||||
static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
|
||||
compress.cache-dir = "/var/cache/lighttpd/compress/"
|
||||
compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
|
||||
include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
|
||||
include_shell "/usr/share/lighttpd/create-mime.assign.pl"
|
||||
include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
|
||||
dir-listing.activate = "disable"
|
||||
|
||||
url.rewrite-if-not-file = (
|
||||
"^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2",
|
||||
"^/([^?]*)" => "/app.php?=$1",
|
||||
)
|
||||
|
||||
Rechte, um das Projektverzeichnis zu betreten
|
||||
---------------------------------------------
|
||||
|
||||
Testumgebung
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Wenn wir nur wallabag testen wollen, führen wir nur das Kommando ``php bin/console server:run --env=prod`` aus, um unsere wallabag Instanz zu starten und alles wird geschmeidig laufen, weil der Nutzer, der das Projekt gestartet hat, den aktuellen Ordner ohne Probleme betreten kann.
|
||||
|
||||
Produktionsumgebung
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Sobald wir Apache oder Nginx nutzen, um unsere wallabag Instanz zu erreichen, und nicht das Kommando ``php bin/console server:run --env=prod`` nutzen, sollten wir dafür sorgen, die Rechte vernünftig zu vergeben, um die Ordner des Projektes zu schützen.
|
||||
|
||||
Um dies zu machen, muss der Ordner, bekannt als ``DocumentRoot`` (bei Apache) oder ``root`` (bei Nginx), von dem Apache-/Nginx-Nutzer zugänglich sein. Sein Name ist meist ``www-data``, ``apache`` oder ``nobody`` (abhängig vom genutzten Linuxsystem).
|
||||
|
||||
Der Ordner ``/var/www/wallabag/web`` musst dem letztgenannten zugänglich sein. Aber dies könnte nicht genug sein, wenn wir nur auf diesen Ordner achten, weil wir eine leere Seite sehen könnten oder einen Fehler 500, wenn wir die Homepage des Projekt öffnen.
|
||||
|
||||
Dies kommt daher, dass wir die gleichen Rechte dem Ordner ``/var/www/wallabag/var`` geben müssen, so wie wir es für den Ordner ``/var/www/wallabag/web`` gemacht haben. Somit beheben wir das Problem mit dem folgenden Kommando:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
chown -R www-data:www-data /var/www/wallabag/var
|
||||
|
||||
Es muss analog für die folgenden Ordner ausgeführt werden
|
||||
|
||||
* /var/www/wallabag/bin/
|
||||
* /var/www/wallabag/app/config/
|
||||
* /var/www/wallabag/vendor/
|
||||
* /var/www/wallabag/data/
|
||||
|
||||
durch Eingabe der Kommandos
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
chown -R www-data:www-data /var/www/wallabag/bin
|
||||
chown -R www-data:www-data /var/www/wallabag/app/config
|
||||
chown -R www-data:www-data /var/www/wallabag/vendor
|
||||
chown -R www-data:www-data /var/www/wallabag/data/
|
||||
|
||||
ansonsten wirst du früher oder später folgenden Fehlermeldung sehen:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
Unable to write to the "bin" directory.
|
||||
file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
|
||||
file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied
|
||||
|
||||
Zusätzliche Regeln für SELinux
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Wenn SELinux in deinem System aktiviert ist, wirst du zusätzliche Kontexte konfigurieren müssen damit wallabag ordentlich funktioniert. Um zu testen, ob SELinux aktiviert ist, führe einfach folgendes aus:
|
||||
|
||||
``getenforce``
|
||||
|
||||
Dies wird ``Enforcing`` ausgeben, wenn SELinux aktiviert ist. Einen neuen Kontext zu erstellen, erfordert die folgende Syntax:
|
||||
|
||||
``semanage fcontext -a -t <context type> <full path>``
|
||||
|
||||
Zum Beispiel:
|
||||
|
||||
``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"``
|
||||
|
||||
Dies wird rekursiv den httpd_sys_content_t Kontext auf das wallabag Verzeichnis und alle darunterliegenden Dateien und Ordner anwenden. Die folgenden Regeln werden gebraucht:
|
||||
|
||||
+-----------------------------------+----------------------------+
|
||||
| Vollständiger Pfad | Kontext |
|
||||
+===================================+============================+
|
||||
| /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` |
|
||||
+-----------------------------------+----------------------------+
|
||||
| /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` |
|
||||
+-----------------------------------+----------------------------+
|
||||
| /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` |
|
||||
+-----------------------------------+----------------------------+
|
||||
| /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` |
|
||||
+-----------------------------------+----------------------------+
|
||||
|
||||
Nach dem diese Kontexte erstellt wurden, tippe das folgende, um deine Regeln anzuwenden:
|
||||
|
||||
``restorecon -R -v /var/www/wallabag``
|
||||
|
||||
Du kannst deine Kontexte in einem Verzeichnis überprüfen, indem du ``ls -lZ`` tippst und alle deine aktuellen Regeln mit ``semanage fcontext -l -C`` überprüfst.
|
||||
|
||||
Wenn du das vorkonfigurierte latest-v2-package installierst, dann ist eine weitere Regel während der Installation nötig:
|
||||
|
||||
``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"``
|
||||
|
||||
Nachdem du erfolgreich dein wallabag erreichst und die Installation fertiggestellt hast, kann dieser Kontext entfernt werden:
|
||||
|
||||
::
|
||||
|
||||
semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var"
|
||||
retorecon -R -v /var/www/wallabag/var
|
||||
13
docs/de/user/login.rst
Normal file
@ -0,0 +1,13 @@
|
||||
Login
|
||||
=====
|
||||
|
||||
Dein Account ist nun aktiviert, Glückwünsch!
|
||||
|
||||
Um dich bei wallabag einzuloggen, fülle das Formular auf der Loginseite aus.
|
||||
|
||||
Wenn du an deinem persönlichen Computer arbeitest und verbunden bleiben willst,
|
||||
kannst du die Checkbox ``Angemeldet bleiben`` anhaken: wallabag wird sich für ein Jahr an deinen Login erinnern.
|
||||
|
||||
.. image:: ../../img/user/login_form.png
|
||||
:alt: Loginformular
|
||||
:align: center
|
||||
62
docs/de/user/migration.rst
Normal file
@ -0,0 +1,62 @@
|
||||
Migration von v1 oder v2
|
||||
========================
|
||||
|
||||
Von wallabag 1.x
|
||||
-----------------
|
||||
|
||||
Wenn du bisher wallabag v1.x genutzt hast, musst du deine Daten exportieren bevor du zu wallabag v2.x migrierst, weil die Applikation und ihre Datenbank sich stark geändert haben. In deiner alten wallabag Installation kannst du deine Daten auf der Konfigurationsseite exportieren.
|
||||
|
||||
.. image:: ../../img/user/export_v1.png
|
||||
:alt: Export von wallabag v1
|
||||
:align: center
|
||||
|
||||
.. note::
|
||||
Wenn du mehrere Accounts auf der gleichen Instanz von wallabag hast, muss jeder Nutzer von v1 exportieren und in v2 seine Daten importieren.
|
||||
|
||||
.. note::
|
||||
Wenn du Probleme während des Exports oder Imports hast, scheue dich nicht davor `nach Hilfe zu fragen <https://www.wallabag.org/pages/support.html>`__.
|
||||
|
||||
Wenn du eine JSON Datei mit deinen Artikeln erhalten hast, kannst du wallabag v2 installieren falls benötigt durch Befolgen `der Standardprozedur <http://doc.wallabag.org/en/master/user/installation.html>`__.
|
||||
|
||||
Nachdem du einen Nutzerkonto auf deiner neuen wallabag v2 Instanz eingerichtet hast, kannst du zu dem Abschnitt `Import` springen und `Import von wallabag v1` auswählen. Wähle deine JSON Datei aus und lade sie hoch.
|
||||
|
||||
.. image:: ../../img/user/import_wallabagv1.png
|
||||
:alt: Import von wallabag v1
|
||||
:align: center
|
||||
|
||||
Import via command-line interface (CLI)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Wenn du CLI Zugang zu deinem Webserver hast, kannst du dieses Kommando ausführen, um deine Aritkel vom wallabag v1 Export zu importieren:
|
||||
|
||||
::
|
||||
|
||||
bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
|
||||
|
||||
Bitte ersetze folgende Werte:
|
||||
|
||||
* ``1`` ist die Nutzer ID in der Databank (Die ID von dem ersten erstellten Nutzer in wallabag ist 1)
|
||||
* ``~/Downloads/wallabag-export-1-2016-04-05.json`` ist der Pfad zu deinem wallabag v1 Export
|
||||
|
||||
Du wirst eine solche Ausgabe erhalten:
|
||||
|
||||
::
|
||||
|
||||
Start : 05-04-2016 11:36:07 ---
|
||||
403 imported
|
||||
0 already saved
|
||||
End : 05-04-2016 11:36:09 ---
|
||||
|
||||
Von wallabag 2.x
|
||||
----------------
|
||||
|
||||
In der vorherigen wallabag Instanz, gehe zu `Alle Artikel` und exportiere diese Artikel als JSON.
|
||||
|
||||
.. image:: ../../img/user/export_v2.png
|
||||
:alt: Export von wallabag v2
|
||||
:align: center
|
||||
|
||||
In deiner neuen wallabag Instanz erstellst du ein Nutzerkonto und klickst auf den Link im Menü, um den Import fortzusetzen. Wähle Import von wallabag v2 aus und lade deine JSON Datei hoch.
|
||||
|
||||
.. note::
|
||||
Wenn du Probleme während des Exports oder Imports hast, scheue dich nicht davor `nach Hilfe zu fragen <https://www.wallabag.org/pages/support.html>`__.
|
||||
2
docs/de/user/tags.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Tags
|
||||
====
|
||||
32
docs/de/user/upgrade.rst
Normal file
@ -0,0 +1,32 @@
|
||||
Wallabag updaten
|
||||
================
|
||||
|
||||
Update auf einem dedizierten Webserver
|
||||
--------------------------------------
|
||||
|
||||
Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.3`` mit der neuesten Releasenummer):
|
||||
|
||||
::
|
||||
|
||||
git fetch origin
|
||||
git fetch --tags
|
||||
git checkout 2.0.3
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console cache:clear --env=prod
|
||||
|
||||
Update auf einem Shared Webhosting
|
||||
----------------------------------
|
||||
|
||||
Sichere deine ``app/config/parameters.yml`` Datei.
|
||||
|
||||
Lade das neueste Release von wallabag herunter:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
|
||||
Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei.
|
||||
|
||||
Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren.
|
||||
|
||||
Leere den ``var/cache`` Ordner.
|
||||
269
docs/en/developer/api.rst
Normal file
12
docs/en/developer/documentation.rst
Normal file
@ -0,0 +1,12 @@
|
||||
Contribute to this documentation
|
||||
================================
|
||||
|
||||
Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs
|
||||
|
||||
We use `ReadTheDocs
|
||||
<https://readthedocs.org>`__ to generate it.
|
||||
|
||||
Pages are written in `Restructured Text
|
||||
<https://en.wikipedia.org/wiki/ReStructuredText>`__ format. You can use online tools like http://rst.aaroniles.net/ or http://rst.ninjs.org/ to preview your articles.
|
||||
|
||||
If you create a new page, don't forget to edit the `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/index.rst>`__ file to add a link in the sidebar.
|
||||
@ -12,15 +12,15 @@ Translation files
|
||||
As wallabag is mainly developed by a French team, please consider that french
|
||||
translation is the most updated one and please copy it to create your own translation.
|
||||
|
||||
You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations.
|
||||
You can find translation files here: https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations.
|
||||
|
||||
You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE
|
||||
is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__).
|
||||
|
||||
Other files to translate:
|
||||
|
||||
- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations.
|
||||
- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations.
|
||||
- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations.
|
||||
- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations.
|
||||
|
||||
You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files.
|
||||
|
||||
@ -28,7 +28,7 @@ Configuration file
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You have to edit `app/config/config.yml
|
||||
<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ to display
|
||||
<https://github.com/wallabag/wallabag/blob/master/app/config/config.yml>`__ to display
|
||||
your language on Configuration page of wallabag (to allow users to switch to this new translation).
|
||||
|
||||
Under the ``wallabag_core.languages`` section, you have to add a new line with
|
||||
@ -55,6 +55,6 @@ wallabag documentation
|
||||
|
||||
Contrary to the web application, the main language for documentation is english.
|
||||
|
||||
Documentation files are stored here: https://github.com/wallabag/wallabag/tree/v2/docs
|
||||
Documentation files are stored here: https://github.com/wallabag/wallabag/tree/master/docs
|
||||
|
||||
You need to respect the ``en`` folder structure when you create your own translation.
|
||||
|
||||
@ -8,7 +8,7 @@ wallabag documentation
|
||||
**wallabag** is a read-it-later application: it saves a web page by
|
||||
keeping content only. Elements like navigation or ads are deleted.
|
||||
|
||||
.. note::
|
||||
.. tip::
|
||||
|
||||
This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__.
|
||||
|
||||
@ -23,17 +23,21 @@ The main documentation for this application is organized into a couple sections:
|
||||
:maxdepth: 2
|
||||
:caption: User documentation
|
||||
|
||||
user/faq
|
||||
user/installation
|
||||
user/upgrade
|
||||
user/migration
|
||||
user/import
|
||||
user/create_account
|
||||
user/login
|
||||
user/configuration
|
||||
user/first_article
|
||||
user/errors_during_fetching
|
||||
user/annotations
|
||||
user/import
|
||||
user/download_articles
|
||||
user/filters
|
||||
user/tags
|
||||
user/android
|
||||
|
||||
.. _dev-docs:
|
||||
|
||||
@ -41,7 +45,8 @@ The main documentation for this application is organized into a couple sections:
|
||||
:maxdepth: 2
|
||||
:caption: Developer documentation
|
||||
|
||||
developer/api
|
||||
developer/docker
|
||||
developer/documentation
|
||||
developer/translate
|
||||
developer/maintenance
|
||||
developer/releasing
|
||||
|
||||
107
docs/en/user/android.rst
Normal file
@ -0,0 +1,107 @@
|
||||
Android App
|
||||
===========
|
||||
|
||||
|
||||
Purpose of this document
|
||||
------------------------
|
||||
|
||||
This document describes how you can setup your Android application to work with your wallabag instance. There is no difference in this procedure for wallabag v1 or v2.
|
||||
|
||||
|
||||
Steps to configure your app
|
||||
---------------------------
|
||||
|
||||
When you first start the app, you see the welcome screen, where you are adviced to configure the app for your wallabag instance at first.
|
||||
|
||||
.. image:: ../../img/user/android_welcome_screen.en.png
|
||||
:alt: Welcome screen
|
||||
:align: center
|
||||
|
||||
Just confirm that message and you get redirected to the settings screen.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_screen.en.png
|
||||
:alt: Settings screen
|
||||
:align: center
|
||||
|
||||
Fill in your wallabag data. You need to enter your wallabag address. It is important that this URL does not end with a slash. Also add your wallabag credentials to the user name and password field.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_filled_in.en.png
|
||||
:alt: Filled in settings
|
||||
:align: center
|
||||
|
||||
After you have filled in your data, push the button Connection test and wait for the test to finish.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_connection_test.en.png
|
||||
:alt: Connection test with your wallabag data
|
||||
:align: center
|
||||
|
||||
The connection test shall finish with success. If not, you need to fix this first until you proceed.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_connection_test_success.en.png
|
||||
:alt: Connection test successful
|
||||
:align: center
|
||||
|
||||
After the connection test was successful, you can push the button to get your feed credentials. The app now tries to login to your wallabag instance and get the user id and the corresponding token for the feeds.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_get_feed_credentials.en.png
|
||||
:alt: Getting the feed credentials
|
||||
:align: center
|
||||
|
||||
When the process of getting your feed credentials finishes with success you see a toast message that the user id and the token were automatically filled in to the form.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png
|
||||
:alt: Getting feed credentials successful
|
||||
:align: center
|
||||
|
||||
Now you need to scroll to the bottom of the settings menu. Of course you can adjust the given settings to your needs. Finish the configuration of your app with pushing the save button.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_scroll_bottom.en.png
|
||||
:alt: Bottom of the settings screen
|
||||
:align: center
|
||||
|
||||
After hitting the save button, you get the following screen. The app proposes to initiate a syncronisation process to update your feeds of articles. It is recommended to acknowledge this action and press Yes.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_saved_feed_update.en.png
|
||||
:alt: Settings saved the first time
|
||||
:align: center
|
||||
|
||||
Finally after the syncronisation finished successfully, you are presented the list of unread articles.
|
||||
|
||||
.. image:: ../../img/user/android_unread_feed_synced.en.png
|
||||
:alt: Filled article list cause feeds successfully syncronized
|
||||
:align: center
|
||||
|
||||
|
||||
|
||||
Known limitations
|
||||
----
|
||||
|
||||
2FA
|
||||
~~~
|
||||
|
||||
Currently the does not support two-factor authentication. You should disable that to get the app working.
|
||||
|
||||
|
||||
Limited amount of articles with wallabag v2
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed.
|
||||
|
||||
|
||||
SSL/TLS encryption
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you can reach your wallabag web instance via HTTPS, you should use that. Especially if your HTTP URL redirects you to the HTTPS one. Currently, the app cannot handle that redirect properly.
|
||||
|
||||
|
||||
References
|
||||
----------
|
||||
|
||||
`Source code of the Android application <https://github.com/wallabag/android-app>`_
|
||||
|
||||
`Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
|
||||
|
||||
`Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
|
||||
|
||||
`Support chat <https://gitter.im/wallabag/wallabag>`_
|
||||
|
||||
@ -21,6 +21,12 @@ Items per page
|
||||
|
||||
You can change the number of articles displayed on each page.
|
||||
|
||||
Reading speed
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
wallabag calculates a reading time for each article. You can define here, thanks to this list, if you are
|
||||
a fast or a slow reader. wallabag will recalculate the reading time for each article.
|
||||
|
||||
Language
|
||||
~~~~~~~~
|
||||
|
||||
@ -102,7 +108,7 @@ Variable Meaning Operator Meaning
|
||||
title Title of the entry <= Less than…
|
||||
url URL of the entry < Strictly less than…
|
||||
isArchived Whether the entry is archived or not => Greater than…
|
||||
isStared Whether the entry is starred or not > Strictly greater than…
|
||||
isStarred Whether the entry is starred or not > Strictly greater than…
|
||||
content The entry's content = Equal to…
|
||||
language The entry's language != Not equal to…
|
||||
mimetype The entry's mime-type OR One rule or another
|
||||
|
||||
@ -23,24 +23,3 @@ Your account is now activated.
|
||||
.. image:: ../../img/user/activated_account.png
|
||||
:alt: Welcome on board!
|
||||
:align: center
|
||||
|
||||
Frequently asked questions
|
||||
--------------------------
|
||||
|
||||
I can't valid the registration form
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Make sure that all fields are well filled:
|
||||
|
||||
* valid email address
|
||||
* same passwords in two fields
|
||||
|
||||
I don't receive my activation email
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Are you sure your email address was correct? Did you check your spams folder?
|
||||
|
||||
When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You already enabled your account or the URL of the activation email is wrong.
|
||||
|
||||
@ -12,9 +12,9 @@ There may be several reasons:
|
||||
How can I help to fix that?
|
||||
---------------------------
|
||||
|
||||
- `by sending us an email with the article's URL <mailto:hello@wallabag.org>`_
|
||||
- `by sending us an email with the article's URL <mailto:hello\@wallabag.org>`_
|
||||
- by trying to fix this article by yourself :) by creating a file for the article.
|
||||
You can use this tool http://siteconfig.fivefilters.org/.
|
||||
You can use `this tool <http://siteconfig.fivefilters.org/>`__.
|
||||
|
||||
How can I try to re-fetch this article?
|
||||
---------------------------------------
|
||||
|
||||
48
docs/en/user/faq.rst
Normal file
@ -0,0 +1,48 @@
|
||||
Frequently Asked Questions
|
||||
==========================
|
||||
|
||||
During the installation, I got the error ``Error Output: sh: 1: @post-cmd: not found``
|
||||
--------------------------------------------------------------------------------------
|
||||
|
||||
It seems you have a problem with your ``composer`` installation. Try to uninstall and reinstall it.
|
||||
|
||||
`Read the documentation about composer to know how to install it
|
||||
<https://getcomposer.org/doc/00-intro.md>`__.
|
||||
|
||||
I can't validate the registration form
|
||||
--------------------------------------
|
||||
|
||||
Ensure that all fields are properly filled:
|
||||
|
||||
* valid email address
|
||||
* same passwords in two fields
|
||||
|
||||
I'm not receiving my activation email
|
||||
-------------------------------------
|
||||
|
||||
Are you sure your email address was correct? Did you check your spam folder?
|
||||
|
||||
If you still don't see the activation email, please ensure that you have
|
||||
installed and properly configured a mail transfer agent. Be sure to include a
|
||||
firewall rule for SMTP. E.g., if using firewalld:
|
||||
|
||||
::
|
||||
|
||||
firewall-cmd --permanent --add-service=smtp
|
||||
firewall-cmd --reload
|
||||
|
||||
Lastly, if you have SELinux enabled, set the following rule:
|
||||
|
||||
``setsebool -P httpd_can_sendmail 1``
|
||||
|
||||
When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
|
||||
----------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
You already enabled your account or the URL of the activation email is wrong.
|
||||
|
||||
I forgot my password
|
||||
--------------------
|
||||
|
||||
You can reset your password by clicking on ``Forgot your password?`` link,
|
||||
on the login page. Then, fill the form with your email address or your username,
|
||||
you'll receive an email to reset your password.
|
||||
@ -1,42 +1,5 @@
|
||||
Migrate to wallabag
|
||||
===================
|
||||
|
||||
From wallabag
|
||||
-------------
|
||||
|
||||
Export your data from your wallabag 1.x
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
On your config page, click on ``JSON export`` in the ``Export your wallabag data`` section.
|
||||
|
||||
.. image:: ../../img/user/export_wllbg_1.png
|
||||
:alt: Export from wallabag 1.x
|
||||
:align: center
|
||||
|
||||
You will have a ``wallabag-export-1-1970-01-01.json`` file.
|
||||
|
||||
Export your data from your wallabag 2.x
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
On the export sidebar, click on ``JSON``.
|
||||
|
||||
.. image:: ../../img/user/export_wllbg_2.png
|
||||
:alt: Export from wallabag 2.x
|
||||
:align: center
|
||||
|
||||
You will have a ``Unread articles.json`` file.
|
||||
|
||||
Import your data into wallabag 2.x
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Click on ``Import`` link in the menu, choose the right wallabag version,
|
||||
select your export file on your computer and import it.
|
||||
|
||||
.. image:: ../../img/user/import_wllbg.png
|
||||
:alt: Import from wallabag 1.x
|
||||
:align: center
|
||||
|
||||
All your wallabag articles will be imported.
|
||||
Migrate from a third service
|
||||
============================
|
||||
|
||||
From Pocket
|
||||
-----------
|
||||
@ -53,7 +16,7 @@ a new application on their developer website to continue.
|
||||
and submit your new application
|
||||
|
||||
Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`).
|
||||
You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag.
|
||||
You need to configure the ``pocket_consumer_key`` into the ``Import`` section in the ``Internal settings`` menu.
|
||||
|
||||
Now, all is fine to migrate from Pocket.
|
||||
|
||||
|
||||
@ -4,9 +4,9 @@ Install wallabag
|
||||
Requirements
|
||||
------------
|
||||
|
||||
wallabag is compatible with php >= 5.5, including php 7.
|
||||
wallabag is compatible with PHP >= 5.5, including PHP 7.
|
||||
|
||||
You'll need the following extensions for wallabag to work. Some of these may already activated in your version of php, so you may not have to install all corresponding packages.
|
||||
You'll need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages.
|
||||
|
||||
- php-session
|
||||
- php-ctype
|
||||
@ -23,18 +23,21 @@ You'll need the following extensions for wallabag to work. Some of these may alr
|
||||
- php-gettext
|
||||
- php-tokenizer
|
||||
|
||||
wallabag uses PDO to connect to database, so you'll need one of:
|
||||
wallabag uses PDO to connect to the database, so you'll need one of the following:
|
||||
|
||||
- php-pdo_mysql
|
||||
- php-pdo_sqlite
|
||||
- php-pdo_pgsql
|
||||
- pdo_mysql
|
||||
- pdo_sqlite
|
||||
- pdo_pgsql
|
||||
|
||||
and it's corresponding database server.
|
||||
and its corresponding database server.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
wallabag uses a big number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you don't already have.
|
||||
On a dedicated web server (recommended way)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
wallabag uses a large number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
|
||||
|
||||
Install Composer:
|
||||
|
||||
@ -42,19 +45,19 @@ Install Composer:
|
||||
|
||||
curl -s http://getcomposer.org/installer | php
|
||||
|
||||
You can find specific instructions here : __ https://getcomposer.org/doc/00-intro.md
|
||||
You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__:
|
||||
|
||||
To install wallabag itself, you must run these two commands:
|
||||
To install wallabag itself, you must run the following commands:
|
||||
|
||||
::
|
||||
|
||||
git clone https://github.com/wallabag/wallabag.git
|
||||
cd wallabag
|
||||
git checkout 2.0.0-beta.2
|
||||
git checkout 2.0.6
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console wallabag:install --env=prod
|
||||
|
||||
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:
|
||||
|
||||
::
|
||||
|
||||
@ -62,10 +65,48 @@ To start php's build-in server and test if everything did install correctly, you
|
||||
|
||||
And access wallabag at http://yourserverip:8000
|
||||
|
||||
Installing on Apache
|
||||
--------------------
|
||||
.. tip::
|
||||
|
||||
Assuming you install wallabag in the /var/www/wallabag folder and that you want to use php as an Apache module, here's a vhost for wallabag:
|
||||
To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look at `Symfony documentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__.
|
||||
|
||||
On a shared hosting
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
We provide a package with all dependencies inside.
|
||||
The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``.
|
||||
|
||||
We already created a user: login and password are ``wallabag``.
|
||||
|
||||
.. caution:: With this package, wallabag doesn't check for mandatory extensions used in the application (theses checks are made during ``composer install`` when you have a dedicated web server, see above).
|
||||
|
||||
Execute this command to download and extract the latest package:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
|
||||
Now, read the following documentation to create your virtual host, then access your wallabag.
|
||||
If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``.
|
||||
|
||||
Installation with Docker
|
||||
------------------------
|
||||
|
||||
We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
|
||||
|
||||
Command to launch container
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker pull wallabag/wallabag
|
||||
|
||||
Virtual hosts
|
||||
-------------
|
||||
|
||||
Configuration on Apache
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you want to use PHP as an Apache module, here's a vhost for wallabag:
|
||||
|
||||
::
|
||||
|
||||
@ -107,10 +148,10 @@ Assuming you install wallabag in the /var/www/wallabag folder and that you want
|
||||
|
||||
After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
|
||||
|
||||
Installing on Nginx
|
||||
-------------------
|
||||
Configuration on Nginx
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag :
|
||||
Assuming you installed wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag :
|
||||
|
||||
::
|
||||
|
||||
@ -146,3 +187,138 @@ Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe
|
||||
}
|
||||
|
||||
After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
|
||||
|
||||
.. tip::
|
||||
|
||||
When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``.
|
||||
|
||||
Configuration on lighttpd
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it):
|
||||
|
||||
::
|
||||
|
||||
server.modules = (
|
||||
"mod_fastcgi",
|
||||
"mod_access",
|
||||
"mod_alias",
|
||||
"mod_compress",
|
||||
"mod_redirect",
|
||||
"mod_rewrite",
|
||||
)
|
||||
server.document-root = "/var/www/wallabag/web"
|
||||
server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
|
||||
server.errorlog = "/var/log/lighttpd/error.log"
|
||||
server.pid-file = "/var/run/lighttpd.pid"
|
||||
server.username = "www-data"
|
||||
server.groupname = "www-data"
|
||||
server.port = 80
|
||||
server.follow-symlink = "enable"
|
||||
index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
|
||||
url.access-deny = ( "~", ".inc" )
|
||||
static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
|
||||
compress.cache-dir = "/var/cache/lighttpd/compress/"
|
||||
compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
|
||||
include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
|
||||
include_shell "/usr/share/lighttpd/create-mime.assign.pl"
|
||||
include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
|
||||
dir-listing.activate = "disable"
|
||||
|
||||
url.rewrite-if-not-file = (
|
||||
"^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2",
|
||||
"^/([^?]*)" => "/app.php?=$1",
|
||||
)
|
||||
|
||||
Rights access to the folders of the project
|
||||
-------------------------------------------
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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).
|
||||
|
||||
So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this could be not enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project.
|
||||
|
||||
This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
chown -R www-data:www-data /var/www/wallabag/var
|
||||
|
||||
It has to be the same for the following folders
|
||||
|
||||
* /var/www/wallabag/bin/
|
||||
* /var/www/wallabag/app/config/
|
||||
* /var/www/wallabag/vendor/
|
||||
* /var/www/wallabag/data/
|
||||
|
||||
by entering
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
chown -R www-data:www-data /var/www/wallabag/bin
|
||||
chown -R www-data:www-data /var/www/wallabag/app/config
|
||||
chown -R www-data:www-data /var/www/wallabag/vendor
|
||||
chown -R www-data:www-data /var/www/wallabag/data/
|
||||
|
||||
otherwise, sooner or later you will see these error messages:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
Unable to write to the "bin" directory.
|
||||
file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
|
||||
file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied
|
||||
|
||||
Additional rules for SELinux
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If SELinux is enabled on your system, you will need to configure additional contexts in order for wallabag to function properly. To check if SELinux is enabled, simply enter the following:
|
||||
|
||||
``getenforce``
|
||||
|
||||
This will return ``Enforcing`` if SELinux is enabled. Creating a new context involves the following syntax:
|
||||
|
||||
``semanage fcontext -a -t <context type> <full path>``
|
||||
|
||||
For example:
|
||||
|
||||
``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"``
|
||||
|
||||
This will recursively apply the httpd_sys_content_t context to the wallabag directory and all underlying files and folders. The following rules are needed:
|
||||
|
||||
+-----------------------------------+----------------------------+
|
||||
| Full path | Context |
|
||||
+===================================+============================+
|
||||
| /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` |
|
||||
+-----------------------------------+----------------------------+
|
||||
| /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` |
|
||||
+-----------------------------------+----------------------------+
|
||||
| /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` |
|
||||
+-----------------------------------+----------------------------+
|
||||
| /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` |
|
||||
+-----------------------------------+----------------------------+
|
||||
|
||||
After creating these contexts, enter the following in order to apply your rules:
|
||||
|
||||
``restorecon -R -v /var/www/wallabag``
|
||||
|
||||
You can check contexts in a directory by typing ``ls -lZ`` and you can see all of your current rules with ``semanage fcontext -l -C``.
|
||||
|
||||
If you're installing the preconfigured latest-v2-package, then an additional rule is needed during the initial setup:
|
||||
|
||||
``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"``
|
||||
|
||||
After you successfully access your wallabag and complete the initial setup, this context can be removed:
|
||||
|
||||
::
|
||||
|
||||
semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var"
|
||||
retorecon -R -v /var/www/wallabag/var
|
||||
|
||||
@ -11,13 +11,3 @@ you can check the ``Keep me logged in`` checkbox: wallabag will remember you for
|
||||
.. image:: ../../img/user/login_form.png
|
||||
:alt: Login form
|
||||
:align: center
|
||||
|
||||
Frequently asked questions
|
||||
--------------------------
|
||||
|
||||
I forgot my password
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You can reset your password by clicking on ``Forgot your password?`` link,
|
||||
on the login page. Then, fill the form with your email address or your username,
|
||||
you'll receive an email to reset your password.
|
||||
|
||||
62
docs/en/user/migration.rst
Normal file
@ -0,0 +1,62 @@
|
||||
Migrate from v1 or v2
|
||||
=====================
|
||||
|
||||
From wallabag 1.x
|
||||
-----------------
|
||||
|
||||
If you were using wallabag v1.x, you need to export your data before migrating to wallabag v2.x, because the application and its database changed a lot. In your old wallabag installation, you can export your data, which can be done on the Config page of your old wallabag installation.
|
||||
|
||||
.. image:: ../../img/user/export_v1.png
|
||||
:alt: Exporting from wallabag v1
|
||||
:align: center
|
||||
|
||||
.. note::
|
||||
If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
|
||||
|
||||
.. note::
|
||||
If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
|
||||
|
||||
When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/master/user/installation.html>`__.
|
||||
|
||||
After creating an user account on your new wallabag v2 instance, you must head over to the `Import` section and select `Import from wallabag v1`. Select your json file and upload it.
|
||||
|
||||
.. image:: ../../img/user/import_wallabagv1.png
|
||||
:alt: Import from wallabag v1
|
||||
:align: center
|
||||
|
||||
Import via command-line interface (CLI)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
|
||||
|
||||
::
|
||||
|
||||
bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
|
||||
|
||||
Please replace values:
|
||||
|
||||
* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
|
||||
* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
|
||||
|
||||
You'll have this in return:
|
||||
|
||||
::
|
||||
|
||||
Start : 05-04-2016 11:36:07 ---
|
||||
403 imported
|
||||
0 already saved
|
||||
End : 05-04-2016 11:36:09 ---
|
||||
|
||||
From wallabag 2.x
|
||||
-----------------
|
||||
|
||||
From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
|
||||
|
||||
.. image:: ../../img/user/export_v2.png
|
||||
:alt: Export depuis wallabag v2
|
||||
:align: center
|
||||
|
||||
From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it.
|
||||
|
||||
.. note::
|
||||
If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
|
||||
32
docs/en/user/upgrade.rst
Normal file
@ -0,0 +1,32 @@
|
||||
Upgrade wallabag
|
||||
================
|
||||
|
||||
Upgrade on a dedicated web server
|
||||
---------------------------------
|
||||
|
||||
The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.3`` by the last release number):
|
||||
|
||||
::
|
||||
|
||||
git fetch origin
|
||||
git fetch --tags
|
||||
git checkout 2.0.3
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console cache:clear --env=prod
|
||||
|
||||
Upgrade on a shared hosting
|
||||
---------------------------
|
||||
|
||||
Backup your ``app/config/parameters.yml`` file.
|
||||
|
||||
Download the last release of wallabag:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
|
||||
Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
|
||||
|
||||
If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
|
||||
|
||||
Empty ``var/cache`` folder.
|
||||
269
docs/fr/developer/api.rst
Normal file
12
docs/fr/developer/documentation.rst
Normal file
@ -0,0 +1,12 @@
|
||||
Contribuer à cette documentation
|
||||
================================
|
||||
|
||||
Les sources de notre documentation sont ici https://github.com/wallabag/wallabag/tree/master/docs
|
||||
|
||||
Nous utilisons `ReadTheDocs
|
||||
<https://readthedocs.org>`__ pour la générer.
|
||||
|
||||
Les pages sont écrites au format `Restructured Text
|
||||
<https://fr.wikipedia.org/wiki/ReStructuredText>`__. Vous pouvez utiliser des outils en ligne comme http://rst.aaroniles.net/ ou http://rst.ninjs.org/ pour prévisualiser vos articles.
|
||||
|
||||
Si vous créez une nouvelle page, n'oubliez pas d'éditer le fichier `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/index.rst>`__ pour ajouter un lien dans la barre latérale.
|
||||
@ -13,15 +13,15 @@ Fichiers de traductions
|
||||
cette traduction qui est considérée comme la plus récente. Merci de vous baser
|
||||
sur celle-ci pour créer votre traduction.
|
||||
|
||||
Les principaux fichiers de traduction se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations.
|
||||
Les principaux fichiers de traduction se trouvent ici : https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations.
|
||||
|
||||
Vous devez créer les fichiers ``messages.CODE.yml`` et ``validators.CODE.yml``,
|
||||
où CODE est le code ISO 639-1 de votre langue (`cf wikipedia <https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1>`__).
|
||||
|
||||
Autres fichiers à traduire :
|
||||
|
||||
- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations.
|
||||
- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations.
|
||||
- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations.
|
||||
- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations.
|
||||
|
||||
Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``.
|
||||
|
||||
@ -29,7 +29,7 @@ Fichier de configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Vous devez éditer `app/config/config.yml
|
||||
<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ pour
|
||||
<https://github.com/wallabag/wallabag/blob/master/app/config/config.yml>`__ pour
|
||||
afficher votre langue dans la page Configuration de wallabag (pour permettre aux
|
||||
utilisateurs de choisir cette nouvelle traduction).
|
||||
|
||||
@ -57,6 +57,6 @@ Documentation de wallabag
|
||||
|
||||
Contrairement à l'application, la langue principale de la documentation est l'anglais
|
||||
|
||||
Les fichiers de documentation se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/docs
|
||||
Les fichiers de documentation se trouvent ici : https://github.com/wallabag/wallabag/tree/master/docs
|
||||
|
||||
Vous devez respecter la structure du dossier ``en`` quand vous crééz votre traduction.
|
||||
|
||||
@ -9,7 +9,7 @@ Documentation de wallabag
|
||||
simplement d’archiver une page web en ne conservant que le contenu. Les
|
||||
éléments superflus (menu, publicité, etc.) sont supprimés.
|
||||
|
||||
.. note::
|
||||
.. tip::
|
||||
|
||||
Vous vous trouvez sur la documentation de wallabag v2. Si vous voulez lire la documentation de wallabag v1, `vous pouvez jeter un œil ici <https://github.com/wallabag/documentation>`__.
|
||||
|
||||
@ -24,14 +24,17 @@ La documentation principale de cette application est découpée en plusieurs sec
|
||||
:maxdepth: 2
|
||||
:caption: Documentation utilisateur
|
||||
|
||||
user/faq
|
||||
user/installation
|
||||
user/upgrade
|
||||
user/migration
|
||||
user/import
|
||||
user/create_account
|
||||
user/login
|
||||
user/configuration
|
||||
user/first_article
|
||||
user/errors_during_fetching
|
||||
user/annotations
|
||||
user/import
|
||||
user/download_articles
|
||||
user/filters
|
||||
user/tags
|
||||
@ -42,6 +45,8 @@ La documentation principale de cette application est découpée en plusieurs sec
|
||||
:maxdepth: 2
|
||||
:caption: Documentation développeur
|
||||
|
||||
developer/api
|
||||
developer/docker
|
||||
developer/documentation
|
||||
developer/translate
|
||||
developer/maintenance
|
||||
|
||||
@ -22,6 +22,11 @@ Nombre d'articles par page
|
||||
|
||||
Vous pouvez définir le nombre d'articles affichés sur chaque page.
|
||||
|
||||
Vitesse de lecture
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
wallabag calcule une durée de lecture pour chaque article. Vous pouvez définir ici, grâce à cette liste déroulante, si vous lisez plus ou moins vite. wallabag recalculera la durée de lecture de chaque article.
|
||||
|
||||
Langue
|
||||
~~~~~~
|
||||
|
||||
@ -105,7 +110,7 @@ Variable Sens Opérateur Sens
|
||||
title Titre de l'article <= Inférieur ou égal à …
|
||||
url URL de l'article < Strictement inférieur à …
|
||||
isArchived Si l'article est archivé ou non => Supérieur ou égal à …
|
||||
isStared Si l'article est en favori ou non > Strictement supérieur à …
|
||||
isStarred Si l'article est en favori ou non > Strictement supérieur à …
|
||||
content Le contenu de l'article = Égal à …
|
||||
language La langue de l'article != Différent de …
|
||||
mimetype The type MIME de l'article OR Telle règle ou telle autre règle
|
||||
|
||||
@ -23,24 +23,3 @@ Votre compte est maintenant actif.
|
||||
.. image:: ../../img/user/activated_account.png
|
||||
:alt: Bienvenue à bord !
|
||||
:align: center
|
||||
|
||||
Foire aux questions
|
||||
-------------------
|
||||
|
||||
Je ne peux pas valider le formulaire de création de compte
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Soyez sur d'avoir bien renseigné tous les champs :
|
||||
|
||||
* une adresse email valide
|
||||
* le même mot de passe dans les deux champs
|
||||
|
||||
Je n'ai pas reçu mon email d'activation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ?
|
||||
|
||||
Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte.
|
||||
|
||||
@ -12,9 +12,9 @@ Il peut y avoir plusieurs raisons :
|
||||
Comment puis-je aider pour réparer ça ?
|
||||
---------------------------------------
|
||||
|
||||
- `en nous envoyant un email avec l'URL de l'article <mailto:hello@wallabag.org>`_
|
||||
- `en nous envoyant un email avec l'URL de l'article <mailto:hello\@wallabag.org>`_
|
||||
- en essayant de réparer cet article par vous-même :) en créant un fichier pour l'article.
|
||||
Vous pouvez utiliser cet outil http://siteconfig.fivefilters.org/.
|
||||
Vous pouvez utiliser `cet outil <http://siteconfig.fivefilters.org/>`__.
|
||||
|
||||
Comment puis-je réessayer de récupérer le contenu ?
|
||||
---------------------------------------------------
|
||||
|
||||
35
docs/fr/user/faq.rst
Normal file
@ -0,0 +1,35 @@
|
||||
Foire Aux Questions
|
||||
===================
|
||||
|
||||
Durant l'installation, je rencontre cette erreur ``Error Output: sh: 1: @post-cmd: not found``
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
Il semblerait que vous ayiez un problème avec votre installation de ``composer``. Essayez de le désinstaller puis de le réinstaller.
|
||||
|
||||
`Vous pouvez lire la documentation de composer pour savoir comment l'installer
|
||||
<https://getcomposer.org/doc/00-intro.md>`__.
|
||||
|
||||
Je ne peux pas valider le formulaire de création de compte
|
||||
----------------------------------------------------------
|
||||
|
||||
Soyez sur d'avoir bien renseigné tous les champs :
|
||||
|
||||
* une adresse email valide
|
||||
* le même mot de passe dans les deux champs
|
||||
|
||||
Je n'ai pas reçu mon email d'activation
|
||||
---------------------------------------
|
||||
|
||||
Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ?
|
||||
|
||||
Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
|
||||
----------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte.
|
||||
|
||||
J'ai oublié mon mot de passe
|
||||
----------------------------
|
||||
|
||||
Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``,
|
||||
sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur,
|
||||
un email vous sera envoyé.
|
||||
@ -1,42 +1,5 @@
|
||||
Migrer à wallabag
|
||||
=================
|
||||
|
||||
Depuis wallabag
|
||||
---------------
|
||||
|
||||
Exportez vos données de wallabag 1.x
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Sur la page de configuration, cliquez sur ``Export JSON`` dans la section ``Exportez vos données wallabag``.
|
||||
|
||||
.. image:: ../../img/user/export_wllbg_1.png
|
||||
:alt: Export depuis wallabag 1.x
|
||||
:align: center
|
||||
|
||||
Vous obtiendrez un fichier ``wallabag-export-1-1970-01-01.json``.
|
||||
|
||||
Exportez vos données de wallabag 2.x
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Dans la barre latérale de téléchargement, cliquez sur ``JSON``.
|
||||
|
||||
.. image:: ../../img/user/export_wllbg_2.png
|
||||
:alt: Export depuis wallabag 2.x
|
||||
:align: center
|
||||
|
||||
Vous obtiendrez un fichier ``Unread articles.json``.
|
||||
|
||||
Importez vos données wallabag 2.x
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Cliquez sur le lien ``Importer`` dans le menu, choisissez la version de wallabag correspondante,
|
||||
sélectionnez votre fichier d'export sur votre ordinateur et importez-le.
|
||||
|
||||
.. image:: ../../img/user/import_wllbg.png
|
||||
:alt: Import depuis wallabag 1.x
|
||||
:align: center
|
||||
|
||||
Tous vos articles wallabag seront importés.
|
||||
Migrer depuis un service externe
|
||||
================================
|
||||
|
||||
Depuis Pocket
|
||||
-------------
|
||||
@ -53,7 +16,7 @@ Vous devez créer une nouvelle application sur leur site dédié aux développeu
|
||||
termes d'utilisation du service et soumettez votre application
|
||||
|
||||
Pocket vous fournira une **Consumer Key** (par exemple, `49961-985e4b92fe21fe4c78d682c1`).
|
||||
Vous devez configurer la ``pocket_consumer_key`` dans le fichier ``app/config/parameters.yml``.
|
||||
Vous devez configurer la ``pocket_consumer_key`` dans la section ``Import`` du menu ``Configuration interne``.
|
||||
|
||||
Maintenant, tout est bien configuré pour migrer depuis Pocket.
|
||||
|
||||
|
||||
@ -4,9 +4,9 @@ Installer wallabag
|
||||
Pré-requis
|
||||
------------
|
||||
|
||||
wallabag est compatible avec php >= 5.5, php 7 inclus.
|
||||
wallabag est compatible avec PHP >= 5.5, PHP 7 inclus.
|
||||
|
||||
Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est possible que certaines de ces extensions soient déjà activées dans votre version de php, donc vous n'avez pas forcément besoin d'installer tous les paquets correspondants.
|
||||
Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est possible que certaines de ces extensions soient déjà activées dans votre version de PHP, donc vous n'avez pas forcément besoin d'installer tous les paquets correspondants.
|
||||
|
||||
- php-session
|
||||
- php-ctype
|
||||
@ -25,14 +25,17 @@ Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est
|
||||
|
||||
wallabag utilise PDO afin de se connecter à une base de données, donc vous aurez besoin d'une extension et d'un système de bases de données parmi :
|
||||
|
||||
- php-pdo_mysql
|
||||
- php-pdo_sqlite
|
||||
- php-pdo_pgsql
|
||||
- pdo_mysql
|
||||
- pdo_sqlite
|
||||
- pdo_pgsql
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
wallabag utilise un grand nombre de bibliothèques pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait.
|
||||
Sur un serveur dédié (méthode conseillée)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
wallabag utilise un grand nombre de bibliothèques pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
|
||||
|
||||
Installation de Composer :
|
||||
|
||||
@ -40,7 +43,7 @@ Installation de Composer :
|
||||
|
||||
curl -s http://getcomposer.org/installer | php
|
||||
|
||||
Vous pouvez trouver des instructions spécifiques ici (en anglais) : __ https://getcomposer.org/doc/00-intro.md
|
||||
Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__ :
|
||||
|
||||
Pour installer wallabag, vous devez exécuter ces deux commandes :
|
||||
|
||||
@ -48,7 +51,7 @@ Pour installer wallabag, vous devez exécuter ces deux commandes :
|
||||
|
||||
git clone https://github.com/wallabag/wallabag.git
|
||||
cd wallabag
|
||||
git checkout 2.0.0-beta.2
|
||||
git checkout 2.0.6
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console wallabag:install --env=prod
|
||||
|
||||
@ -60,10 +63,47 @@ Pour démarrer le serveur interne à php et vérifier que tout s'est installé c
|
||||
|
||||
Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
|
||||
|
||||
Installation avec Apache
|
||||
.. tip::
|
||||
Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire `documentation Symfony <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ pour en savoir plus.
|
||||
|
||||
Sur un serveur mutualisé
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Nous mettons à votre disposition une archive avec toutes les dépendances à l'intérieur.
|
||||
La configuration par défaut utilise SQLite pour la base de données. Si vous souhaitez changer ces paramètres, vous devez modifier le fichier ``app/config/parameters.yml``.
|
||||
|
||||
Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``.
|
||||
|
||||
.. caution:: Avec cette archive, wallabag ne vérifie pas si les extensions obligatoires sont présentes sur votre serveur pour bien fonctionner (ces vérifications sont faites durant le ``composer install`` quand vous avez un serveur dédié, voir ci-dessus).
|
||||
|
||||
Exécutez cette commande pour télécharger et décompresser l'archive :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
|
||||
Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag.
|
||||
Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``.
|
||||
|
||||
Installation avec Docker
|
||||
------------------------
|
||||
|
||||
En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag et que vous utilisiez php comme un module Apache, voici un vhost pour wallabag :
|
||||
Nous vous proposons une image Docker pour installer wallabag facilement. Allez voir du côté de `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ pour plus d'informations.
|
||||
|
||||
Commande pour démarrer le containeur
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker pull wallabag/wallabag
|
||||
|
||||
Virtual hosts
|
||||
-------------
|
||||
|
||||
Configuration avec Apache
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag`` et que vous utilisiez PHP comme un module Apache, voici un vhost pour wallabag :
|
||||
|
||||
::
|
||||
|
||||
@ -105,10 +145,10 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab
|
||||
|
||||
Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
|
||||
|
||||
Installation avec Nginx
|
||||
-----------------------
|
||||
Configuration avec Nginx
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag, voici un fichier de configuration Nginx pour wallabag :
|
||||
En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag :
|
||||
|
||||
::
|
||||
|
||||
@ -144,3 +184,91 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab
|
||||
}
|
||||
|
||||
Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
|
||||
|
||||
.. tip::
|
||||
|
||||
Si vous voulez importer un fichier important dans wallabag, vous devez ajouter cette ligne dans votre configuration nginx ``client_max_body_size XM; # allows file uploads up to X megabytes``.
|
||||
|
||||
Configuration avec lighttpd
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration pour wallabag (éditez votre fichier ``lighttpd.conf`` collez-y cette configuration) :
|
||||
|
||||
::
|
||||
|
||||
server.modules = (
|
||||
"mod_fastcgi",
|
||||
"mod_access",
|
||||
"mod_alias",
|
||||
"mod_compress",
|
||||
"mod_redirect",
|
||||
"mod_rewrite",
|
||||
)
|
||||
server.document-root = "/var/www/wallabag/web"
|
||||
server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
|
||||
server.errorlog = "/var/log/lighttpd/error.log"
|
||||
server.pid-file = "/var/run/lighttpd.pid"
|
||||
server.username = "www-data"
|
||||
server.groupname = "www-data"
|
||||
server.port = 80
|
||||
server.follow-symlink = "enable"
|
||||
index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
|
||||
url.access-deny = ( "~", ".inc" )
|
||||
static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
|
||||
compress.cache-dir = "/var/cache/lighttpd/compress/"
|
||||
compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
|
||||
include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
|
||||
include_shell "/usr/share/lighttpd/create-mime.assign.pl"
|
||||
include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
|
||||
dir-listing.activate = "disable"
|
||||
|
||||
url.rewrite-if-not-file = (
|
||||
"^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
|
||||
"^/([^?]*)" => "/app.php?=$1",
|
||||
)
|
||||
|
||||
Droits d'accès aux dossiers du projet
|
||||
-------------------------------------
|
||||
|
||||
Environnement de test
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Quand nous souhaitons juste tester wallabag, nous lançons simplement la commande ``php bin/console server:run --env=prod`` pour démarrer l'instance wallabag et tout se passe correctement car l'utilisateur qui a démarré le projet a accès naturellement au repertoire courant, tout va bien.
|
||||
|
||||
Environnement de production
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Dès lors que nous utilisons Apache ou Nginx pour accéder à notre instance wallabag, et non plus la commande ``php bin/console server:run --env=prod`` pour la démarrer, il faut prendre garde à octroyer les bons droits aux bons dossiers afin de préserver la sécurité de l'ensemble des fichiers fournis par le projet.
|
||||
|
||||
Aussi, le dossier, connu sous le nom de ``DocumentRoot`` (pour apache) ou ``root`` (pour Nginx), doit être impérativement accessible par l'utilisateur de Apache ou Nginx. Le nom de cet utilisateur est généralement ``www-data``, ``apache`` ou ``nobody`` (selon les systèmes linux utilisés).
|
||||
|
||||
Donc le dossier ``/var/www/wallabag/web`` doit être accessible par ce dernier. Mais cela ne suffira pas si nous nous contentons de ce dossier, et nous pourrions avoir, au mieux une page blanche en accédant à la page d'accueil du projet, au pire une erreur 500.
|
||||
|
||||
Cela est dû au fait qu'il faut aussi octroyer les mêmes droits d'accès au dossier ``/var/www/wallabag/var`` que ceux octroyés au dossier ``/var/www/wallabag/web``. Ainsi, on règle le problème par la commande suivante :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
chown -R www-data:www-data /var/www/wallabag/var
|
||||
|
||||
Il en est de même pour les dossiers suivants :
|
||||
|
||||
* /var/www/wallabag/bin/
|
||||
* /var/www/wallabag/app/config/
|
||||
* /var/www/wallabag/vendor/
|
||||
|
||||
en tapant
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
chown -R www-data:www-data /var/www/wallabag/bin
|
||||
chown -R www-data:www-data /var/www/wallabag/app/config
|
||||
chown -R www-data:www-data /var/www/wallabag/vendor
|
||||
|
||||
sinon lors de la mise à jour vous finirez par rencontrer les erreurs suivantes :
|
||||
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
Unable to write to the "bin" directory.
|
||||
file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
|
||||
file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied
|
||||
|
||||
@ -11,13 +11,3 @@ vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous
|
||||
.. image:: ../../img/user/login_form.png
|
||||
:alt: Formulaire de connexion
|
||||
:align: center
|
||||
|
||||
Foire aux questions
|
||||
-------------------
|
||||
|
||||
J'ai oublié mon mot de passe
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``,
|
||||
sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur,
|
||||
un email vous sera envoyé.
|
||||
|
||||
62
docs/fr/user/migration.rst
Normal file
@ -0,0 +1,62 @@
|
||||
Migrer depuis la v1 ou la v2
|
||||
============================
|
||||
|
||||
Depuis wallabag 1.x
|
||||
-------------------
|
||||
|
||||
Si vous utilisiez wallabag v1.x, vous devez exporter vos données avant de migrer à wallabag v2.x, à cause du changement complet de l'application et de sa base de données. Sur votre ancienne instance de wallabag v1, vous pouvez exporter vos données en allant sur la page de configuration de l'application.
|
||||
|
||||
.. image:: ../../img/user/export_v1.png
|
||||
:alt: Export depuis wallabag v1
|
||||
:align: center
|
||||
|
||||
.. note::
|
||||
Si vous avez plusieurs comptes sur la même instance de wallabag, chaque utilisateur doit exporter ses données depuis wallabag v1 et les importer dans la v2.
|
||||
|
||||
.. note::
|
||||
S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide <https://www.wallabag.org/pages/support.html>`__.
|
||||
|
||||
Une fois que vous avez récupéré le fichier json contenant vos données, vous pouvez installer wallabag v2 si c'est nécessaire en suivant `la procédure standard <http://doc.wallabag.org/fr/master/user/installation.html>`__.
|
||||
|
||||
Une fois que vous avez créé un compte utilisateur sur votre nouvelle instance de wallabag v2, rendez-vous dans la section `Import`. Vous devez choisir l'import depuis wallabag v1 puis sélectionner votre fichier json récupéré précédemment.
|
||||
|
||||
.. image:: ../../img/user/import_wallabagv1.png
|
||||
:alt: Import depuis wallabag v1
|
||||
:align: center
|
||||
|
||||
Import via via la ligne de commande (CLI)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Si vous avez accès à la ligne de commandes de votre serveur web, vous pouvez exécuter cette commande pour import votre fichier wallabag v1 :
|
||||
|
||||
::
|
||||
|
||||
bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
|
||||
|
||||
Remplacez les valeurs :
|
||||
|
||||
* ``1`` est l'identifiant de votre utilisateur en base (l'ID de votre premier utilisateur créé sur wallabag est 1)
|
||||
* ``~/Downloads/wallabag-export-1-2016-04-05.json`` est le chemin de votre export wallabag v1
|
||||
|
||||
Vous obtiendrez :
|
||||
|
||||
::
|
||||
|
||||
Start : 05-04-2016 11:36:07 ---
|
||||
403 imported
|
||||
0 already saved
|
||||
End : 05-04-2016 11:36:09 ---
|
||||
|
||||
Depuis wallabag 2.x
|
||||
-------------------
|
||||
|
||||
Depuis l'instance sur laquelle vous étiez, rendez-vous dans la section `Tous les articles`, puis exportez ces articles au format json.
|
||||
|
||||
.. image:: ../../img/user/export_v2.png
|
||||
:alt: Export depuis wallabag v2
|
||||
:align: center
|
||||
|
||||
Depuis votre nouvelle instance de wallabag, créez votre compte utilisateur puis cliquez sur le lien dans le menu pour accéder à l'import. Choisissez l'import depuis wallabag v2 puis sélectionnez votre fichier json pour l'uploader.
|
||||
|
||||
.. note::
|
||||
S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide <https://www.wallabag.org/pages/support.html>`__.
|
||||
32
docs/fr/user/upgrade.rst
Normal file
@ -0,0 +1,32 @@
|
||||
Mettre à jour wallabag
|
||||
======================
|
||||
|
||||
Mise à jour sur un serveur dédié
|
||||
--------------------------------
|
||||
|
||||
La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.3`` par le numéro de la dernière version) :
|
||||
|
||||
::
|
||||
|
||||
git fetch origin
|
||||
git fetch --tags
|
||||
git checkout 2.0.3
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console cache:clear --env=prod
|
||||
|
||||
Mise à jour sur un hébergement mutualisé
|
||||
----------------------------------------
|
||||
|
||||
Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
|
||||
|
||||
Téléchargez la dernière version de wallabag :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
|
||||
Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
|
||||
|
||||
Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
|
||||
|
||||
Videz le répertoire ``var/cache``.
|
||||
BIN
docs/img/user/android_configuration_connection_test.de.png
Normal file
|
After Width: | Height: | Size: 80 KiB |
BIN
docs/img/user/android_configuration_connection_test.en.png
Normal file
|
After Width: | Height: | Size: 79 KiB |
|
After Width: | Height: | Size: 81 KiB |
|
After Width: | Height: | Size: 80 KiB |
|
After Width: | Height: | Size: 108 KiB |
|
After Width: | Height: | Size: 104 KiB |
BIN
docs/img/user/android_configuration_filled_in.de.png
Normal file
|
After Width: | Height: | Size: 95 KiB |
BIN
docs/img/user/android_configuration_filled_in.en.png
Normal file
|
After Width: | Height: | Size: 96 KiB |
BIN
docs/img/user/android_configuration_get_feed_credentials.de.png
Normal file
|
After Width: | Height: | Size: 81 KiB |
BIN
docs/img/user/android_configuration_get_feed_credentials.en.png
Normal file
|
After Width: | Height: | Size: 79 KiB |