Skip to content
Website creation automated with Nim. Run the file and your website is ready
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
config Info about noX on headless server Mar 7, 2019
devops Add desktop file, Minor Mar 1, 2019
docs
nimwcpkg Peer review feedback Mar 20, 2019
plugins
private/screenshots Corrected logo Jul 1, 2018
public
.gitattributes
.gitignore
CHANGELOG.md
LICENSE
README.md Update readme Mar 19, 2019
nimwc.nim Minor, constant string plugin skeleton Mar 19, 2019
nimwc.nim.cfg
nimwc.nimble Documentation: Move new docs to /docs/ Mar 9, 2019

README.md

Nim Website Creator

A quick website tool. Run the nim file and access your webpage. Website: https://nimwc.org

Features

Blogs and pages

  • 1 Click Blogging posts directly from browser.
  • 1 Click Static web pages directly from browser.
  • WYSIWYG & Drag'n'Drop Editors with Summernote, CodeMirror or GrapesJS.
  • Custom title, meta description and keywords for each page, SEO friendly.
  • Custom head, navbar and footer, no hardcoded watermarks, links or logos.
  • Upload/Download files and images (private or public), option to use MD5 CheckSum as filename.
  • Libravatar/Gravatar support for profile photos builtin.
  • 1 language for the whole stack, including high performance modules, scripting, devops, deploy, from WebAssembly to Assembly.

Security

  • Self-Firejailing Web Framework (It Firejails itself) Best Linux Security integrated on the Core.
  • 2 Factor Athentication TOTP
  • ReCAPTCHA
  • HoneyPot-Field
  • BCrypt+Salt password hashing
  • No user Tracking Analytics by default
  • SQL Type-checked and Query-checked at compile-time, no SQL injections.
  • Multiple users with different ranks, role based access control.
  • Admin can choose how much CPU & RAM NimWC can use from the Admin Dashboard.
  • We recommend FreeOTP 2 Factor Athentication App because is Open Source.

Configuration

  • Edit core or custom JS and CSS directly from browser, UI/UX Designer friendly.
  • Log Viewer directly from browser.
  • Auto-Rotating file Logger.
  • Server Info Page for Admins.
  • Force Server restart for Admins.
  • Edit main config file directly from browser
  • Recompilation without down times.
  • Webserver hosting your page on 127.0.0.1:7000
  • Colored output on the Terminal.
  • Email notification on critical errors.

Plugins

  • Plugin Store integrated
  • Enable and disable plugins directly from browser. Open Source or Private Plugins.
  • Plugin skeleton creator to create your own new plugins.
  • Plugins can do anything you want on Frontend and Backend.
  • Develop your own plugins - NimWC plugin repository

Database

  • Postgres (if you are using the NimWC docker file, you do not need to install Postgres)
  • SQLite

Performance

  • High performance with low resources (RPi, VPS, cloud, old pc, etc).
  • Runs on any non-Windows OS, Architecture and Hardware that can compile C code.
  • Independent TechEmpower Benchmarks show Nim web server as one of the fastest in the world.
  • High Availability design by default.
  • Full Stack with the same programming language, including DevOps and Scripting.
  • 0 Dependency binary (Postgres/SSL/WebP/Firejail required if using it).
  • No /node_modules/, but very powerful builtin Templating engine.
  • Compile-Time precomputed arbitrary function execution is used when possible.
  • No Global Interpreter Lock, no single-Thread, no single-Core, no Interpreter. Use all your 32 CPU Cores.

Responsive

Other

Requirements

To get started you only need:

Development dependencies (automatically installed by Nimble):

Foreing optional dependencies:

  • webp (libwebp)
  • firejail >= 0.9.58
  • Xvfb (xorg-server-xvfb)

For stable development use Nim Stable Release, Devel may or may not work, but is not stable by definition.

Install

Install Nim

To compile and install you need Nim. You can easily install Nim using choosenim with:

curl https://nim-lang.org/choosenim/init.sh -sSf | sh

Install NimWC

You only need to perform 1a or 1b - not both of them.

1a) Install

If you are using [Nimble](https://github.com/nim-lang/nimble) an executable will be generated and symlinked to `nimwc`, which then can be executed anywhere on your system.
# Install nimwc with nimble
nimble install nimwc

# Edit the config.cfg accordingly
# (change the confg.cfg path to your nimble folder and the correct package version)
nano ~/.nimble/pkgs/nimwc-5.0.0/config/config.cfg

# Run nimwc
# (to add an Admin user append "newuser": nimwc --newuser -u:admin -p:pass -e:a@a.com)
# (to include some standard pages: nimwc --insertdata)
nimwc

# Login
127.0.0.1:7000/login

1b) Compile

This will generate the executable in the folder.

# Clone the repository
git clone https://github.com/ThomasTJdev/nim_websitecreator
cd nim_websitecreator

# Generate and edit the config.cfg accordingly
cp config/config_default.cfg config/config.cfg
nano config/config.cfg

# Install dependencies
nimble install jester recaptcha bcrypt datetime2human otp firejail webp

# Compile nimwc
nim c nimwc.nim

# Run nimwc
# (to add an Admin user append "--newuser": ./nimwc --newuser -u:admin -p:pass -e:a@a.com)
# (to include some standard pages: nimwc --insertdata)
./nimwc

# Login
127.0.0.1:7000/login

Use

Arguments

These arguments should be prepended to executable file, e.g. ./nimwc cdata

  • --newuser = Add the Admin user. The -u:<username>, -p:<password> and -e:<email> args are required. E.g. --newuser -u:admin -p:pass -e:a@a.com
    • -u:<admin username>
    • -p:<admin password>
    • -e:<admin email>
  • --insertdata = Insert standard data (this will override existing data)
    • bulma = Use Bulma CSS
    • bootstrap = Use Bootstrap and jQuery
    • clean = No framework is used
  • --newdb = Generates the database with standard tables (does not override or delete tables). newdb will be initialized automatic, if no database exists.
  • --gitupdate = Updates and force a hard reset
  • --initplugin = Create plugin skeleton inside tmp/

Compile options:

These options are only available at compiletime:

  • -d:rc = Recompile. NimWC is using a launcher, it is therefore needed to force a recompile.
  • -d:adminnotify = Send error logs (ERROR) to the specified admin email
  • -d:dev = Development
  • -d:devemailon = Send email when -d:dev is activated
  • -d:demo = Used on public test site Nim Website Creator. This option will override the database each hour with the standard data.
  • -d:gitupdate = Updates and force a hard reset
  • -d:postgres = Use Postgres database instead of SQLite

User profiles

There are 3 main user profiles:

  • User
  • Moderator
  • Admin

The access rights below applies to main program. Plugins can have their own definition of user rights.

User

The "User" can login and see private pages and blog pages. This user has no access to adding or editing anything.

Moderator

The "Moderator" can login and see private pages and blog pages. The user can add and delete users, but cannot delete or add "Admin" users. The user cannot edit JS, CSS and core HTML - only within the pages and blogposts.

Admin

The "Admin" has access to anything.

Blog

You can easily add and edit blogpages. The blogpages support metadata: meta description and meta keywords. It is also possible to specify a category and tags.

Blog sorting

In the settings menu you can specify how your blogposts should be sorted, e.g. on modfied date in ascending order.

Blog searching

To only show blogpost with a specific name, tag or category, you have to append the criteria to the URL. It is not possible to combine these.

website.com/blog?name=nim
website.com/blog?category=article
website.com/blog?tags=code

Plugins

Multiple plugins are available. You can download them within the program at <webpage>/plugins/repo.

The plugin repository are located here: NimWC plugin repository

Shortcuts

When editing a blogpage or a normal page press Ctrl+S to save.

GrapesJS

GrapesJS is a Web Builder Framework. To use GrapeJS with a CSS framework (Bulma or Bootstrap), you have to edit public/js/grapejs_custom.js and public/js/grapejsbs4.min.js. Bootstrap support in public/js/grapejs_custom.js is commented out.

DevOps

Docker, Vagrant, SystemD Service, NGNIX, Admin stuff, etc

Docker

Vagrant

NGNIX Config

Google reCAPTCHA

To activate Google reCAPTCHA claim you site and server key and insert them into config.cfg.

SystemD

Copy the file called nimwc.service inside /lib/systemd/system/

sudo nano /lib/systemd/system/nimwc.service

Enable auto start and start it:

sudo systemctl enable nimwc
sudo systemctl start nimwc
sudo systemctl status nimwc

How to Firejail

  • Default settings will work Ok on most systems, sane defaults.
  • Some settings are kind of technical, you should know some Linux Kernel related stuff.
  • Links are provided on the Firejail config page when makes sense.
  • You can harden your system even more by tweaking the Firejail config.
  • You can always come back to the default settings and it will work Ok.
  • Check that Firejail Status at bottom of the page is mostly green.

You can choose how much CPU & RAM NimWC can use, Firejail will make NimWC believe that theres less CPU & RAM that the actually physically available. If you choose too small resources for too big load, then it will feel like when you try to run a heavy program on a VirtualBox with too small CPU & RAM, but will still run, or do the best to try to run. This can be useful for Clouds that charge you extra when you pass certain threshold of CPU & RAM usage.

NimWC does not depend on any Hardware device to run, like audio, video, USB, DVD, etc, so you can block the access to the hardware peripehals, that also blocks its hardware drivers and libraries that may have vulnerabilities, making your NimWC more secure.

There are options to block root user and the rest of the users on the Linux system, thats help protect your NimWC against Privilege Scalations, thats when an unprivileged normal user becomes superuser root, or an user can see other users stuff.

Caches and Temporary directories are mounted as private temporary unique autogenerated TMPFS, meaning that the real ones can not be altered from within NimWC.

noMnt=true is for when you run 1 instance NimWC per server, noMnt=false is for when you run multiple instances NimWC per server, because it may or may not block other instances of accesing subfolders on /mnt/ simultaneously.

noX=false if you are running a headless server or ChromeBook. noX=true uses Xvfb for X Isolation (xorg-server-xvfb), you may need to install it if you want to use it, but is not a hard dependency, just use noX=false and you dont need to install it if you dont want to.

The features come from the Linux Kernel itself, so theres zero cost on performance and the technology is already there even if you use it or not.

So in conclusion NimWC being compiled binary wont need access to most of your system, just its own folder, the integration with Firejails hides everything else.

Install

You local version of firejail to needs be >= 0.9.58. Install using your package manager:

# Arch (package manager)
sudo pacman -S firejail

# Ubuntu (built files)
https://launchpad.net/ubuntu/+source/firejail/0.9.58-1 # <-- download
sudo apt install ./firejail_0.9.58-1_arm64.deb

# Compile
git clone https://github.com/netblue30/firejail.git
cd firejail
./configure && make && sudo make install-strip
How to Jester

https://github.com/juancarlospaco/nim-presentation-slides/blob/master/ejemplos/basico/jester/hello_web_3.nim#L38

Resources
You can’t perform that action at this time.