Skip to content

Usages

Jump to bottom
mauricelambert edited this page Sep 8, 2021 · 6 revisions

Usages

Commands line

WebScripts

Using the python module:

Linux

python3 -m WebScripts

Windows

python -m WebScripts

Arguments

Help message

WebScripts --help
WebScripts -h

Change interface and port

WebScripts --interface "192.168.1.2" --port 80
WebScripts -i "192.168.1.2" -p 80

Accept unauthenticated user

WebScripts --accept-unauthenticated-user --accept-unknow-user

Add configuration from INI files

WebScripts --config-cfg "config1.ini" "config2.ini" --config-cfg "config3.ini"
WebScripts -c "config1.ini" "config2.ini" -c "config3.ini"

Add configuration from JSON files

WebScripts --config-json "config1.json" "config2.json" --config-json "config3.json"
WebScripts -j "config1.json" "config2.json" -j "config3.json"

Desactive authentication script

WebScripts --active-auth
WebScripts -a

Auth script

WebScripts --auth-script "auth.py"

Script paths

WebScripts --scripts-path "./scripts/1/" "./scripts/2/" --scripts-path "./scripts/3/"
WebScripts -S "./scripts/1/" "./scripts/2/" -S "./scripts/3/"

Script configuration paths

WebScripts --scripts-config "./config/1/*.json" "./config/2/*.ini" --scripts-config "./config/3/*.json"
WebScripts -S "./config/1/*.json" "./config/2/*.ini" -S "./config/3/*.json"

Modules

WebScripts --modules "module1" "module2" --modules "module3"
WebScripts -m "module1" "module2" -m "module3"

Module paths

WebScripts --modules-path "./modules/1/" "./modules/2/" --modules-path "./modules/3/"
WebScripts -I "./modules/1/" "./modules/2/" -I "./modules/3/"

Documentation paths

WebScripts --documentations-path "./doc/1/" "./doc/2/" --documentations-path "./doc/3/"
WebScripts -D "./doc/1/" "./doc/2/" -D "./doc/3/"

Javascript paths

WebScripts --js-path "./js/1/" "./js/2/" --js-path "./js/3/"
WebScripts -J "./js/1/" "./js/2/" -J "./js/3/"

Static paths

WebScripts --statics-path "./images/1/" "./templates/html/2/" --statics-path "./css/3/"
WebScripts -T "./images/1/" "./templates/html/2/" -T "./css/3/"

DEV

Mode debug

  • To get python error message and traceback on page 500.
  • To get the existing URLs on page 404.
  • To export the server configuration to the JSON file named export_Configuration.json.
WebScripts --debug
WebScripts -d

Mode not secure

  • Do not use HTTP security headers, useful for debugging web scripts (javascript)
WebScripts --security
WebScripts -s

LOGS

Level

  • Configure the root logger (other loggers are not impacted)
  • Level must be in {0 DEBUG INFO WARNING ERROR CRITICAL}
WebScripts --log-level DEBUG
WebScripts -l DEBUG

Filename

  • Configure the root logger (other loggers are not impacted)
WebScripts --log-filename "logs.log"
WebScripts -f "logs.log"

Encoding

  • Configure the root logger (other loggers are not impacted)
WebScripts --log-encoding "utf-8"

Format

  • Configure the root logger (other loggers are not impacted)
WebScripts --log-format "%(asctime)s %(levelname)s %(message)s (%(funcName)s -> %(filename)s:%(lineno)d)"

Date format

  • Configure the root logger (other loggers are not impacted)
WebScripts --log-date-format "%d/%m/%Y %H:%M:%S"

SMTP

Server

  • Configure the SMTP server name to send email notifications
WebScripts --smtp-server "my.smtp.server"
WebScripts --s-server "my.smtp.server"

StartTLS

  • Configure the secure connection with StartTLS
WebScripts --smtp-starttls
WebScripts --s-tls

Password

  • Configure the SMTP login (username is the notification_address configuration), if password is None the WebScripts Server send the email notifications without authentication.
WebScripts --smtp-password "password"
WebScripts --s-password "password"

Port

  • Configure the SMTP server port
WebScripts --smtp-port 25
WebScripts --s-port 25

SSL

  • Configure the secure connection with SSL
WebScripts --smtp-ssl
WebScripts --s-ssl

Receivers/Administrators email addresses

  • Configure the receivers email addresses (should be the administrators addresses)
WebScripts --admin-adresses "[email protected]" "[email protected]" --admin-adresses "[email protected]"
WebScripts --a-adr "[email protected]" "[email protected]" --a-adr "[email protected]"

Sender

  • Configure the sender email address
WebScripts --notification-address "[email protected]"
WebScripts --n-adr "[email protected]"

License

Licensed under the GPL, version 3.

Clone this wiki locally