wallabag / doc Goto Github PK

Documentation repository for wallabag v2.

doc gitbook netlify wallabag hacktoberfest

doc's Introduction

wallabag

wallabag is a web application allowing you to save web pages for later reading. Click, save and read it when you want. It extracts content so that you won't be distracted by pop-ups and cie.

You can install it on your own server, or you can create an account on wallabag.it.

Website: wallabag.org
Android app: wallabag/android-app
iOS app: wallabag/ios-app
Browser extension: wallabag/wallabagger
GNOME (Linux) app: read-it-later (not maintained by this project)
All resources about wallabag ecosystem are listed here: https://github.com/wallabag/wallabag/wiki/wallabag-ecosystem

Documentation

The documentation is available at https://doc.wallabag.org.

You can contribute to it through its dedicated repository, available here: https://github.com/wallabag/doc.

Installation

Please read the documentation to see the wallabag requirements.

Then you can install wallabag by executing the following commands:

git clone https://github.com/wallabag/wallabag.git
cd wallabag && make install

Now, configure a virtual host to use your wallabag.

Other methods

Refer to the installation documentation for other installation methods.

Translation

This project uses Weblate for translation.

Feel free to help us translating wallabag.

Contributing

To learn more about developing wallabag, please refer to the contribution guide.

Content extraction relies on Graby, php-readability and ftr-site-config.

License

This work is free. You can redistribute it and/or modify it under the terms of the MIT License. See the COPYING.md file for more details.

doc's People

Contributors

Stargazers

Watchers

doc's Issues

404 for the link "errors_during_fetching.html#how-can-i-help-to-fix-that"

From @tdelmas on May 30, 2017 21:4

That link, used by github template issues and shown by the android app is a 404 :

http://doc.wallabag.org/en/master/user/errors_during_fetching.html#how-can-i-help-to-fix-that

Copied from original issue: wallabag/wallabag#3166

Caddy VirtualHosts needs updating for Caddy V2

I haven't been able to massage the caddy 1 virtual host configuration in doc/virtualhosts.md to work with caddy 2.
There have been slight changes in the CaddyFile format.

Does anyone have a working configuration to add to the docs?

Migrate doc to php7

Mostly vhosts.
Add warnings « if you're on php5.6, change xxx »

Use Apache 2.4 vhost by default

Installation is taking too much of ram

Hi,
I am trying to install latest version of this software on my Raspberry Pi 2 B+ which has ram of only 1G. The problem is installation is taking too much of RAM, more than 1G, because of which installation is failing. Is there a way to limit the amount of RAM for making process?

PHP 7.0.30-0+deb9u1, apache2 2.4.25-3+deb9u5 on raspbian based on debian stretch.

Thanks

wrong docker launch command in docs

The documentation (https://doc.wallabag.org/en/admin/installation/installation.html#command-to-launch-container) states
docker pull
as the command to launch wallabag. However, this command will never launch a container but only pull the image from docker hub.

Update doc for Le Point paywall

Hi,

An issue to remind us to update the documentation once PR fivefilters/ftr-site-config#581 has been merged and integrated into wallabag. The French journal "Le Point" will then be supported for paywalled access.

Files to modify : [language]/user/articles/restricted.md

Fix link to api methods in developer/api/methods.md

The link in the bottom here: https://doc.wallabag.org/en/developer/api/methods.html#other-methods
currently points to http://localhost:8000/api/doc

Maybe this link should point to an existing site like wallabag.it api?

wallabag can't retrieve contents for this article

Hello.

After trying to keep this https://www.grafikart.fr/tutoriels/divers/json-web-token-presentation-958, wallabag doesn't want retreive the content of this site.

I have tried with f43.me as explain in [troubleshoot this issue.](troubleshoot this issue.).

It works, but with the external parser.

Best regards.

Add a full page about internal settings

Like the one we did for the parameters / user config, we should have one full page with full details about each settings.

Please, add to errors_during_fetching.md local location of site-config files

Please, add to errors_during_fetching.md local location of site-config files.
To allow local debugging and fast fixing of site fetching.

Where be the warnings of shared hosting?

Currently, on the installation page of Wallabag's documentation, there's a placeholder in place that reads:

Here should be a few warnings on shared hosting for instance

Scary! 😨 What are the warnings on shared hosting? C'mon, we can do better on this 😉

Asynchronus Jobs -- https://doc.wallabag.org/en/admin/asynchronous.html

What are the recommended cron times (i.e. how often should asynchronous tasks be run)? Can this be clarified in the documentation? I can probably create a PR.

Update Installation section

There has been some discussions over there regarding the installation instructions, and there has been multiple tickets for such issues.

I am volunteering to work on this in the coming weeks (with an "s"). Please feel free to contribute here issues you might have had installing wallabag on a dedicated host, shared host or other configurations.

Is keeping DE and IT doc right?

Hi everyone,

I was wondering if keeping the German (DE) and Italian (IT) documentation was still relevant... I don't think a lot of people willing to install wallabag on their/some server don't read English at all, and the translations seem to have dropped behind.

I can understand having the French one as most (all ?) of the core developers (and contributors?) are French. At some point, however, shouldn't we concentrate on fewer languages with better quality; and not have obsolete docs?

I don't want to bite the hand that feeds me (cracher dans la soupe), it's just that it seems like an interesting thinking to have.

No instruction about administrator role

I see no any document described a normal server setup workflow for newbies.
I want to use own server – and what set of components should I use, setup and configure?
Should I use some big toys – rabbitmq, cloudron, redis?
Shold I create a special admin user, give admin permisssions to a my regular user, other variant?

How can I do it? Use php bin/console fos:user:promote and set a role? What role name? I set admin and administrator, without success.

Documentation for import formats

I'm trying to migrate (or try to do it) my current Raindrop.io bookmarks to wallabag. I see I can export from raindrop in html, csv and text formats, but I've been unable to match any of them with current wallabag import options.

So my guess is that at some point I'm going to do a manual (or using mlr command line utility) selection of CSV columns to import to wallabag in the format it need. But, which format is it?. Is there any specification with the mandatory and optional columns to import?. Do they need to be in a specific order or have a specific names?. Where can I find this sort of information?

Thank you in advanced.

Composer < 2.3

in the system requirements maybe also mention that wallabag requires composer 2.3 or lower. It won’t install wir composer 2.5.3.

Best

Shared hosting documentation broken

For shared hosting, the current documentation references a package to pull from wllbg.org.

For this host,

the certificate is not matching
the package is not available (404)

wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package

https://github.com/wallabag/doc/blob/master/en/admin/installation/installation.md#on-shared-hosting

Unable to install on mac os

HI, I tried to install this on mac os following the install instructions but yarn gitbook install failed:

michaelstevens@Michaels-MacBook-Air doc % yarn gitbook install
yarn run v1.22.19
warning package.json: No license field
warning ../package.json: No license field
$ /Users/michaelstevens/doc/node_modules/.bin/gitbook install
Installing GitBook 3.2.3
/Users/michaelstevens/doc/node_modules/npm/node_modules/graceful-fs/polyfills.js:287
      if (cb) cb.apply(this, arguments)
                 ^

TypeError: cb.apply is not a function
    at /Users/michaelstevens/doc/node_modules/npm/node_modules/graceful-fs/polyfills.js:287:18
    at FSReqCallback.oncomplete (node:fs:191:5)

Node.js v19.3.0
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

I tested node 18 to see if it made a difference:

michaelstevens@Michaels-MacBook-Air doc % yarn gitbook install
yarn run v1.22.19
warning package.json: No license field
warning ../package.json: No license field
$ /Users/michaelstevens/doc/node_modules/.bin/gitbook install
Installing GitBook 3.2.3
/Users/michaelstevens/doc/node_modules/npm/node_modules/graceful-fs/polyfills.js:287
      if (cb) cb.apply(this, arguments)
                 ^

TypeError: cb.apply is not a function
    at /Users/michaelstevens/doc/node_modules/npm/node_modules/graceful-fs/polyfills.js:287:18
    at FSReqCallback.oncomplete (node:fs:208:5)

Node.js v18.12.1
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

gitbook-cli looked abandoned so I managed to get something generating with this diff:

diff --git a/book.json b/book.json
index 6f6098a..843a696 100644
--- a/book.json
+++ b/book.json
@@ -2,7 +2,6 @@
     "plugins": [
         "edit-link",
         "toggle-chapters",
-        "page-toc",
         "-sharing",
         "versions",
         "hints",
diff --git a/package.json b/package.json
index 4ce3c73..6d9efb0 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,11 @@
 {
   "dependencies": {
-    "gitbook-cli": "^2.3.2"
+    "gitbook-plugin-edit-link": "^2.0.2",
+    "gitbook-plugin-hints": "^1.0.2",
+    "gitbook-plugin-localized-footer": "^0.3.1",
+    "gitbook-plugin-page-toc": "^1.1.1",
+    "gitbook-plugin-toggle-chapters": "^0.0.3",
+    "gitbook-plugin-versions": "^2.1.4",
+    "honkit": "^4.0.4"
   }
 }

(note it becomes yarn honkit serve to run a local server)

but I do get a bunch of warnings so not totally happy with it.

Upgrade instructions for Self-Hosted instances missing

Hi,
thanks for the product and the docs. I don't dare to upgrade to 2.5.2 from 2.4.2 because there is no hints on how to do that and what tables might have changed. I already managed 2.3.8 to 2.4.2, but for the recent version the guide is still missing.
Would be highly appreciated!

BTW, but not doc-related: Maybe a console PHP command for all these upgrades might be a good idea in the future?

Add a fail2ban configuration

Regarding wallabag/wallabag#3195 it might be a good idea to have a basic fail2ban config to temporaly ban a user after few auth failure.

Add Yunohost and Synology

We need to add these packages in our installation page (like for cloudron).

Errors during fetching

Hi,
Just for information, following wallabag/wallabag#3773, I began working on an update for the Errors during fetching part of the documentation.

I am writing the French version first (as it is my mother language, and I think the one of most of the core developers of wallabag), PR it, and if it is okay for you I'll translate it in English.

I'll keep you updated, I just wanted to open an issue so no other people would work on it at the same time :).

Cheers

Add documentation about email configuration

Unless I'm missing it, there does not seem any specific documentation about email configuration and IIUC as per issue #2046, a user cannot declare ports nor configure wallabag to do tls connections

Broken alerts blocks on Gitbook

Hi everyone,

There is an issue with the alerts plugin on GitBook, with following blocks being not detected as separated, and consequently colors being weird and so on.

Two info blocks separated by a blank line should be separated:

One info and one warn blocks share the color of the latter:

I really like those blocks as they pop really well in a page, but it's a shame that they're not detected well. The plugin is not maintained anymore, maybe we should fall back on the built-in warning system (even if it's not well documented?).

There is not so much of these blocks, so I would be glad to make the change, if someone with access to the Gitbook interface can confirm that the following code is working without plugins on gitbook:

{% hint style="info" %}
Hello world
{% endhint %}

with style equal to info, success, danger or warning.

Missing SELinux fcontext rule

It seems that wallabag needs to write to some more directories not listed in the SELinux section of doc/en/admin/installation/rightaccess.md.

I recommend adding following line:

semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var/sessions(/.*)?"
semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var/logs(/.*)?"
semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/assets/images(/.*)?"

doc.wallabag.org needs to be updated

I was having issues using the client_credentials grant type without knowing this feature had been reverted. #30 reverted the docs, but it's not reflected at https://doc.wallabag.org/en/developer/api/oauth.html .

[need more testing] Caddy webserver

From @Rurik19 on July 28, 2017 6:38

I run wallabagger v2.2.3 on caddy server v0.10.4 with config just like that:

yourdomain.ru {
  root /var/www/wallabagger/web
  fastcgi / /var/run/php7-fpm.sock php {
    index app.php
  }
  rewrite / {
    to {path} {path}/ /app.php?{query}
  }
  tls [email protected]
  log /var/log/caddy/wbg.access.log
  errors /var/log/caddy/wbg.error.log
}

Both UI and API works like a charm. If somebody else test it, we should add it to the docs

Copied from original issue: wallabag/wallabag#3295

Add information about downloading images

I can't find a piece of information about how to enable downloading images, where they will be saved, etc.

Tagging rules example docu on operators is wrong

currently it is:

domainName = "github.com"

But that does not work as expected. it should be

domainName matches "github.com"

https://github.com/wallabag/doc/blob/master/en/user/configuration/tagging_rules.md

chat log reporting this issue:

04:57 Hey, I'm trying to add some custom tags but they don't seem to be getting added to articles I add which should be hitting the fields to mark the tags.. here are the 3 that don't work:
04:58 if « domainName = "digitalocean.com" » then tag as « digitaloceantutorials »
04:58 if « content = "ubuntu" » then tag as « ubuntu »
04:58 if « content = "docker" » then tag as « docker »
11:23 @D347HxD new tagging rules are only applied to the articles, which you are going to add afterwards, not for existing ones.
16:51 @Strubbl that's what I mean. I added articles after making these tags that should trigger the content but they didn't get Tagged
16:52 I added the docker install tutorial from digital ocean after making the tags for example. Nothing was added but all tags should have
17:35 maybe you should try the "matches" operator instead of the equal
18:40 So, like this? @Strubbl https://i.godhub.xyz/07-07-2019-c3flZtmCK9.png
18:40 but with github.com as digitalocean.com
18:42 Yup, that worked. Thanks @Strubbl
18:42 Maybe this should be fixed as an example, as this is what got my using the = in the first place: https://i.godhub.xyz/07-07-2019-ePJIbbfsVe.png
18:43 would the content also need to use matches? seems it doesnt work for =
18:45 yup, content also needs to be matches and not =
18:45 that should also be fixed in that instruction area

FAQ point for getting error PHP Fatal error: Class 'Sensio\Bundle\GeneratorBundle\SensioGeneratorBundle' not found in /var/www/wallabag2/app/AppKernel.php on line 49

when issuing a command like php bin/console and you forget --env=prod, you get the error message

PHP Fatal error: Class 'Sensio\Bundle\GeneratorBundle\SensioGeneratorBundle' not found in /var/www/wallabag2/app/AppKernel.php on line 49

I always forget that when only looking at the documentation here: https://doc.wallabag.org/en/admin/console_commands.html

So i guess, it would make sense to:

add a hint box to the above mentioned commands page that you shall not forget env parameter (see https://github.com/wallabag/doc/pull/19/files#diff-060ffd258fa2d53d2e9f9d6d23a285b7)
add a FAQ entry with the above mentioned error message

Update documentation for shared hosting should mention that ALL parameters are mandatory in parameters.yml

Environment

Version:2.3.8
Installation:shared hosting
PHP version:7.2
OS:linux
Database:MySQL
Parameters:

I tried twice to upgrade to 2.4.0 on shared hosting and finally succeded.
What was not clear in the upgrade documentation was that ALL parameters as found here are mandatory otherwise wallabag will fail.

I ran bin/console cache:clear --env=prod and it runs a kind a sanity check that helped me understand what was going on and what parameters were missing.

In my case I had to add

mailer_port: false
mailer_encryption: ~
mailer_auth_mode: ~

and those two, despite not being flagged as new in 2.4.0 on the documentation page

fos_oauth_server_access_token_lifetime: 3600
fos_oauth_server_refresh_token_lifetime: 1209600

My suggestion would be : to mention specifically to add those 3 (or 5 if you confirm it) parameters for upgrade to 2.4.0 and that all parameters must be present in the file for wallabag to work.
I'm happy to do it if it's agreed.

Add documentation for the export/import tagging rules feature

We need to document wallabag/wallabag#2284 (wallabag/wallabag#4028).