nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-01-21 07:55:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding script capability

Browse Source
This commit is contained in:
James Vasile 2011-02-22 13:33:35 -05:00
parent 35071d7212
commit c108b443d3
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/scripts.mdwn Normal file
View File

@ -0,0 +1,24 @@
# Scripts
The Plinth front end should not directly change any aspect of the
underlying operating system. Instead, it should call upon scripts,
either by shell command or (for python modules) via import.
Scripts live in `/scripts`. They should have the following
characteristics:
* Do only one thing
* Require no interaction beyond passing parameters or commandline
arguments
* Change the operation of the services and applications of the Freedom
Plug and nothing else.
* If a script is a python file, it should be *both* usable from the
commandline and importable as a python module.
The scripts should be of general utility. They should be usable to
admin and configure the system even in the absence of Plinth. These
scripts are the only supported method of making changes to a Freedom
Plug, whtether by SSH or via Plinth.