No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
class
database
doc
favicon
.gitignore
.htaccess
README.md
bootstrap.php
composer.json
config.php.dist
cron.php
favicon.ico
index.php

README.md

Shaarli REST API

Installation

Requirements

  • PHP 5.4.4
  • MySQL or Sqlite
  • PDO
  • Apache RewriteEngine or Nginx (see doc folder)

Update your installation

  • Update your installation via Git (git update origin master) or the archive file.
  • Check if there was any changes in config file, and add settings if necessary.
  • Update external libraries with Composer. Run: composer update.
  • Run cron the finalize the update: php cron.php --verbose.

Install via SSH exemple (debian)

cd /var/www
# Clone repo
git clone https://github.com/mknexen/shaarli-api.git
# Create mysql database
mysqladmin create shaarli-api -p
cd shaarli-api
# Copy `config.php.dist` into `config.php` and setup your own settings.
cp config.php.dist config.php
nano config.php
# Run composer install
php -r "readfile('https://getcomposer.org/installer');" | php
php composer.phar install
# Run cron, for initialization we recommend using the argument --verbose (or -v) to be sure everything working fine
php cron.php --verbose

API Usage

  • /feeds La liste des shaarlis
  • /latest Les derniers billets
  • /top Les liens les plus partagés
  • /search Rechercher dans les billets
  • /discussion Rechercher une discussion
  • /syncfeeds Synchroniser la liste des shaarlis

Options

  • &format=json
  • &pretty=true

Samples