You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
55 lines
1.7 KiB
55 lines
1.7 KiB
8 years ago
|
* Back to [main read-me](../README.md)
|
||
|
|
||
|
# FreshRSS Command-Line Interface (CLI)
|
||
|
|
||
|
## Note on access rights
|
||
|
|
||
|
When using the command-line interface, remember that your user might not be the same as the one used by your Web server.
|
||
|
This might create some access right problems.
|
||
|
|
||
|
It is recommended to invoke commands using the same user as your Web server:
|
||
|
|
||
|
```sh
|
||
|
cd /usr/share/FreshRSS
|
||
|
sudo -u www-data sh -c './cli/list-users.php'
|
||
|
```
|
||
|
|
||
|
In any case, when you are done with a series of commands, you should re-apply the access rights:
|
||
|
|
||
|
```sh
|
||
|
cd /usr/share/FreshRSS
|
||
|
sudo chown -R :www-data .
|
||
|
sudo chmod -R g+r .
|
||
|
sudo chmod -R g+w ./data/
|
||
|
```
|
||
|
|
||
|
|
||
|
## Commands
|
||
|
|
||
|
Options in parenthesis are optional.
|
||
|
|
||
|
|
||
|
```sh
|
||
|
cd /usr/share/FreshRSS
|
||
|
|
||
|
./cli/do-install.php --default_user admin --auth_type form ( --environment production --base_url https://rss.example.net/ --language en --title FreshRSS --allow_anonymous --api_enabled --db-type mysql --db-host localhost:3306 --db-user freshrss --db-password dbPassword123 --db-base freshrss --db-prefix freshrss )
|
||
|
# The default database is SQLite
|
||
|
# Does not create the default user. Do that with ./cli/create-user.php
|
||
|
|
||
|
./cli/create-user.php --user username ( --password 'password' --api-password 'api_password' --language en --email user@example.net --token 'longRandomString' --no-default-feeds )
|
||
|
|
||
|
./cli/delete-user.php --user username
|
||
|
|
||
|
./cli/list-users.php
|
||
|
# Return a list of users, with the default/admin user first
|
||
|
|
||
|
./cli/actualize-user.php --user username
|
||
|
|
||
|
./cli/import-for-user.php --user username --filename /path/to/file.ext
|
||
|
|
||
|
./cli/export-opml-for-user.php --user username > /path/to/file.opml.xml
|
||
|
|
||
|
./cli/export-zip-for-user.php --user username ( --max-feed-entries 100 ) > /path/to/file.zip
|
||
|
|
||
|
```
|