saiyan/selim

Selim

selim

CLI Tool for scanning Silverstripe-CMS Installations, _(*1)

, _(*2)

Requirements

• composer
• symfony/yaml: v2.6.1
• pear/console_table: 1.2.1

Installation

git clone https://github.com/Saiyan/selim.git
cd selim
composer install

Or, _(*3)

Commands

php bin/selim.php  command [options] [arguments]

Before you can start to use selim you have to tell it where your silverstripe folders are. For this you can use the two commands "find" and "add"., _(*4)

find

php bin/selim.php find PATH

This command searches for all possible paths of silverstripe project-folders. After that selim will prompt you for every found folder which name you want to assign to each folder., _(*5)

add

php bin/selim.php add <NAME> </PATH/TO/MYSITE/>

The NAME for your site is just a String so you can identify your site later on whereas the PATH needs to be the path to the "project" folder of your silverstripe instance. If you dont change it after installing Silverstripe it should be the "mysite" folder., _(*6)

rm

If you want to remove a page "NAME" from your config then just use, _(*7)

php bin/selim.php rm NAME

security

this command reads the Version of your site "NAME" and shows all security vulnerabilities known for this version, _(*8)

php bin/selim.php security NAME

start

This is the main command to use with selim. "start" lists all sites that you added and their properties., _(*9)

php bin/selim.php start [OPTIONS]

options

--html

To generate html and send the output to a html file you could do something like this., _(*10)

php bin/selim.php start --html > htmloutput.html

--template

Default:, _(*11)

{% for page in pages %}

Site:            {{ page.getName }}
Root:            {{ page.getRootPath }}
Version:         {{ page.getVersion }}
DefaultAdmin:    {{ page.hasDefaultAdmin }}
EmailLogging:    {{ page.hasEmailLogging }}
EnvironmentType: {{ page.getEnvironmentType }}
Modules:         {% for module in page.getModules %}{{ module }} {% endfor %}

{% endfor %}

Example:, _(*12)

 #List the names of all sites and the path to their _config.php
php bin/selim.php start --template=my_own_template.twig

--filter-name

if you don't want to see all your sites listed you can filter the results shown to you with --filter-name= Everything after the parameter name will be interpreted as a Regular Expression and will be tested against the name of the site., _(*13)

Some Examples, _(*14)

//list every site which starts with the string "site"
--filter-name=^site

//list every site which name ends with the string "site"
--filter-name=site$

//list only sites which have only characters in their name  
--filter-name=\w+

--filter-module

//list only sites with userforms module  
--filter-module=userforms

--filter-da

//list only sites which use Security::setDefaultAdmin   
--filter-da

--filter-env

//list only sites which have a specific environment type set (dev,live or test)   
--filter-env=dev

global options

--config=

Naturally selim uses/generates the config.json file in its own directory. If you want to use another config-file you can use the --config parameter, _(*15)

--config=/home/user/temp/my-selim-config-file

Build

Building a phar for selim is easy. Get the Repository. Use composer to install all dependencies. Let Box do all the work.(http://box-project.org/), _(*16)

git clone https://github.com/Saiyan/selim.git selim-build
cd selim-build
composer global require "kherge/box:~2.0"
~/.composer/vendor/kherge/box/bin/box build -v
#Composer under Windows uses the following path 
#~\AppData\Roaming\Composer\vendor\kherge\box\bin\box