diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/en/developer/console_commands.rst | 30 | ||||
-rw-r--r-- | docs/en/user/import.rst | 15 | ||||
-rw-r--r-- | docs/fr/developer/console_commands.rst | 30 |
3 files changed, 70 insertions, 5 deletions
diff --git a/docs/en/developer/console_commands.rst b/docs/en/developer/console_commands.rst new file mode 100644 index 00000000..85a8a092 --- /dev/null +++ b/docs/en/developer/console_commands.rst | |||
@@ -0,0 +1,30 @@ | |||
1 | Console Commands | ||
2 | ================ | ||
3 | |||
4 | wallabag has a number of CLI commands to manage a number of tasks. You can list all the commands by executing `bin/console` in the wallabag folder. | ||
5 | |||
6 | Each command has a help accessible through `bin/console help %command%`. | ||
7 | |||
8 | .. note:: | ||
9 | |||
10 | If you're in a production environment, remember to add `-e prod` to each command. | ||
11 | |||
12 | Notable commands | ||
13 | ---------------- | ||
14 | |||
15 | * `assets:install`: May be helpful if assets are missing. | ||
16 | * `cache:clear`: should be run after each update (included in `make update`). | ||
17 | * `doctrine:migrations:status`: Output the status of your database migrations. | ||
18 | * `fos:user:activate`: Manually activate an user. | ||
19 | * `fos:user:change-password`: Change a password for an user. | ||
20 | * `fos:user:create`: Create an user. | ||
21 | * `fos:user:deactivate`: Deactivate an user (not deleted). | ||
22 | * `fos:user:demote`: Removes a role from an user, typically admin rights. | ||
23 | * `fos:user:promote`: Adds a role to an user, typically admin rights. | ||
24 | * `rabbitmq:*`: May be useful if you're using RabbitMQ. | ||
25 | * `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users | ||
26 | * `wallabag:export`: Exports all entries for an user. You can choose the output path of the file. | ||
27 | * `wallabag:import`: Import entries to different formats to an user account. | ||
28 | * `wallabag:import:redis-worker`: Useful if you use Redis. | ||
29 | * `wallabag:install`: (re)Install wallabag | ||
30 | * `wallabag:tag:all`: Tag all entries for an user using his/her tagging rules. | ||
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 50bb1de3..f6aaa373 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -77,7 +77,7 @@ From Instapaper | |||
77 | --------------- | 77 | --------------- |
78 | 78 | ||
79 | Export your Instapaper data | 79 | Export your Instapaper data |
80 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 80 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
81 | 81 | ||
82 | On the settings (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). | 82 | On the settings (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). |
83 | 83 | ||
@@ -133,16 +133,21 @@ If you have a CLI access on your web server, you can execute this command to imp | |||
133 | 133 | ||
134 | :: | 134 | :: |
135 | 135 | ||
136 | bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod | 136 | bin/console wallabag:import username ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod |
137 | 137 | ||
138 | Please replace values: | 138 | Please replace values: |
139 | 139 | ||
140 | * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) | 140 | * ``username`` is the user's username |
141 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export | 141 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export |
142 | 142 | ||
143 | If you want to mark all these entries as read, you can add the ``--markAsRead`` option. | 143 | .. note:: |
144 | If you want to mark all these entries as read, you can add the ``--markAsRead`` option. | ||
144 | 145 | ||
145 | To import a wallabag v2 file, you need to add the option ``--importer=v2``. | 146 | .. note:: |
147 | To import a wallabag v2 file, you need to add the option ``--importer=v2``. | ||
148 | |||
149 | .. note:: | ||
150 | If you want to pass the user id of the user instead of it's username, add the option ``--useUserId=true``. | ||
146 | 151 | ||
147 | You'll have this in return: | 152 | You'll have this in return: |
148 | 153 | ||
diff --git a/docs/fr/developer/console_commands.rst b/docs/fr/developer/console_commands.rst new file mode 100644 index 00000000..1b222b32 --- /dev/null +++ b/docs/fr/developer/console_commands.rst | |||
@@ -0,0 +1,30 @@ | |||
1 | Actions en ligne de commande | ||
2 | ============================ | ||
3 | |||
4 | wallabag a un certain nombre de commandes CLI pour effectuer des tâches. Vous pouvez lister toutes les commandes en exécutant `bin/console` dans le dossier d'installation de wallabag. | ||
5 | |||
6 | Chaque commande a une aide correspondante accessible via `bin/console help %command%`. | ||
7 | |||
8 | .. note:: | ||
9 | |||
10 | Si vous êtes dans un environnement de production, souvenez-vous d'ajouter `-e prod` à chaque commande. | ||
11 | |||
12 | Commandes notables | ||
13 | ------------------ | ||
14 | |||
15 | * `assets:install`: Peut-être utile si les *assets* sont manquants. | ||
16 | * `cache:clear`: doit être exécuté après chaque mise à jour (appelé dans `make update`). | ||
17 | * `doctrine:migrations:status`: Montre le statut de vos migrations de vos bases de données. | ||
18 | * `fos:user:activate`: Activer manuellement un utilisateur. | ||
19 | * `fos:user:change-password`: Changer le mot de passe pour un utilisateur. | ||
20 | * `fos:user:create`: Créer un utilisateur. | ||
21 | * `fos:user:deactivate`: Désactiver un utilisateur (non supprimé). | ||
22 | * `fos:user:demote`: Supprimer un rôle d'un utilisateur, typiquement les droits d'administration. | ||
23 | * `fos:user:promote`: Ajoute un rôle à un utilisateur, typiquement les droits d'administration. | ||
24 | * `rabbitmq:*`: Peut-être utile si vous utilisez RabbitMQ. | ||
25 | * `wallabag:clean-duplicates`: Supprime tous les articles dupliqués pour un utilisateur ou bien tous. | ||
26 | * `wallabag:export`: Exporte tous les articles pour un utilisateur. Vous pouvez choisir le chemin du fichier exporté. | ||
27 | * `wallabag:import`: Importe les articles en différents formats dans un compte utilisateur. | ||
28 | * `wallabag:import:redis-worker`: Utile si vous utilisez Redis. | ||
29 | * `wallabag:install`: (ré)Installer wallabag | ||
30 | * `wallabag:tag:all`: Tagger tous les articles pour un utilisateur ou une utilisatrice en utilisant ses règles de tags automatiques. | ||