Installation guide

The supported method involves uwsgi. You may have to download and install it.

Dependencies

To fully build Nanowork (make all) and be able to make changes, you will need:

make:The well known builder lesscss:The less css compiler (lessc)

jsmin:

Any javascript minifier using stdin/stdout

Tip

You can replace it by cat in the Makefile to avoid this dependency

sphinx:

The documentation builder framework

Tip

Just type make to know all possible targets, you can then make target

Configuring

Edit sample_config.ini, you’ll find explanations below:

[general]

home

Path of the sources (you cloned or unpacked that folder) (ex: /home/toto/temporary/weye.git).

shared_root

Used in file manager, this is the path of the root folder you want Nanowork to work on.

file_encoding

File encoding of your filesystem (utf-8 by default).

no_overwrite

Set it to yes, true or active to de-activate overwrite on the server. Uploading new files will still granted if read_only is false.

read_only

Do not allow any write operation.

debug

Enable or disables debugging informations (currently broken)

[uwsgi]

chdir

You must chdir to Nanowork sources’ path for Nanowork to work

http-socket

The ip:port you want to enable Nanowork on:

ip

The default IP address will only listen on local host, if you want to be accessible from anybody, set it to 0.0.0.0.

port

HTTP port to work on, if you run uwsgi with a proper configuration you may avoid giving the port number (ex: :8080) on the URL to connect to the server.

Running

uwsgi sample_config.ini

Hint

You can move and rename the sample_config.ini file of course ! Just think about changing the uwsgi‘s chdir option accordingly.

Important

You must run make mimes if you didn’t start Nanowork using the Quick run method — You may need the cat trick as well

Custom configurations

You will find a ready to use WSGI object under weye.application:application.

Generated files

static/mime/js/ and static/mimetypes.js

Hint

You can rebuild those files using make mimes

• mimes/type/js/ folders are copied to static/mime/js/type/

• Subfolders of mimes are parsed and compiled into static/mimetypes.js

  view.js:

  contains function display(item) {} definition, executed with item’s informations on ready

  style.css:

  [optional] a CSS file with additional definitions

  dependencies.js:  

  [optional] contains files to load (relative to js folder), currently only js files will be loaded automatically.

  Example:

  [
  "rainbow.min.js",
  "foobar.js"
  ]
  

static/css/theme.css

Hint

You can rebuild those files using make themes

The themes/default.less file is compiled using LESS and the copied to theme.css.

doc/source/dev/jsapi.rst

Hint

You can rebuild those files using make jsapi

Built from the docstrings in static/application.js

doc/build/html/index.html

Hint

You can rebuild those files using make doc