https://github.com/0x46616c6b/etherpad-lite-console

A thin console toolkit to maintain an etherpad lite instance
https://github.com/0x46616c6b/etherpad-lite-console

Last synced: about 1 month ago
JSON representation

A thin console toolkit to maintain an etherpad lite instance

• Host: GitHub
• URL: https://github.com/0x46616c6b/etherpad-lite-console
• Owner: 0x46616c6b
• License: gpl-3.0
• Archived: true
• Created: 2013-11-08T13:55:33.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2021-04-05T05:59:13.000Z (over 3 years ago)
• Last Synced: 2024-08-02T12:43:00.420Z (4 months ago)
• Language: PHP
• Homepage: https://github.com/0x46616c6b/etherpad-lite-console
• Size: 63.5 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - 0x46616c6b/etherpad-lite-console - A thin console toolkit to maintain an etherpad lite instance (others)

README

        
# Etherpad Lite Console (PHP)

![Continuous Integration](https://github.com/0x46616c6b/etherpad-lite-console/workflows/Continuous%20Integration/badge.svg) [![Latest Stable Version](https://poser.pugx.org/0x46616c6b/etherpad-lite-console/v/stable.png)](https://packagist.org/packages/0x46616c6b/etherpad-lite-console) [![License](https://poser.pugx.org/0x46616c6b/etherpad-lite-console/license.png)](https://packagist.org/packages/0x46616c6b/etherpad-lite-console) [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/0x46616c6b/etherpad-lite-console/badges/quality-score.png?s=4bd527762446d5ea536787bf5ab611488d1dd7d6)](https://scrutinizer-ci.com/g/0x46616c6b/etherpad-lite-console/)

**A thin console toolkit to maintain an etherpad lite instance**

## Installation

    git clone https://github.com/0x46616c6b/etherpad-lite-console.git

    

    cd etherpad-lite-console

    

    composer install

    ./bin/console

Sample Output

    Etherpad Lite Console version 0.1

    

    Usage:

      [options] command [arguments]

    

    Options:

      --help           -h Display this help message.

      --quiet          -q Do not output any message.

      --verbose        -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

      --version        -V Display this application version.

      --ansi              Force ANSI output.

      --no-ansi           Disable ANSI output.

      --no-interaction -n Do not ask any interactive question.

    

    Available commands:

      help                  Displays help for a command

      list                  Lists commands

    pad

      pad:delete            Delete a pad

      pad:purge             Purge pads which older then x days

    redis

      redis:import:sqlite   Imports a sqlite database to redis

## Current features

* Delete a pad

* Purge old pads (*avoid massive data retention*)

  * White- or blacklist pads by suffixes to their pad IDs

* Migration

  * From SQLite to Redis

## Purging pads by suffixes

Suffixes to pad IDs can be used for variable expiry pad times. E.g. to

purge pads with suffix '-1day' after 1 day, with '-1year' after 365 days

and all other pads after 60 days, do the following:

    ./bin/console pad:purge --days=1 --suffix=-1day

    ./bin/console pad:purge --days=365 --suffix=-1year

    ./bin/console pad:purge --days=60 --ignore-suffix=-1day --ignore-suffix=-1year

## Implementation

* based on the [Symfony Console Component](http://symfony.com/doc/current/components/console/introduction.html)

* Dependencies:

   * [symfony/console](https://packagist.org/packages/predis/predis)

   * [predis/predis](https://packagist.org/packages/predis/predis)

   * [0x46616c6b/etherpad-lite-client](https://packagist.org/packages/0x46616c6b/etherpad-lite-client)

## Wishlist

* More Migration (MySQL -> Redis, ...)

* Stats, stats, stats