In order to run Heretic, you will need a web server which can run Node.js scripts. There are no special requirements, so if you can install and use Node, you can host a Heretic website.
In case your site needs additional features, such as database access, control panel, etc., you will also need to install additional packages.
Heretic can be run on the server as a standalone application or in a Docker container (or in Docker Compose). Running Heretic in a container is preferable because it allows Heretic's operation to be separated from the main host and is more secure.
The easiest way to run a fully functional and maintainable version of Heretic is to use Docker Compose. You can choose one of the options (Heretic only, Heretic + MongoDB, Heretic + Redis, or all at once). Each application runs in a separate container, and the containers are connected by a common network.
This option requires downloading the interactive script using the following command:
curl -sS -o docker-compose.sh https://hereticjs.org/composeNext, run the script by executing the command:
bash docker-compose.shFinally, start docker compose containers by running:
docker compose up -dIn its base configuration, Heretic requires nothing more than the standard features provided by Node.js. If you do not require advanced features such as user management, database, etc., you can run Heretic in a container using the following commands.
docker run -d --name heretic -v /var/www/heretic/dist:/heretic/dist -v /var/www/heretic/site:/heretic/site -v /var/www/heretic/logs:/heretic/logs -v /var/www/heretic/backup:/heretic/backup -p 3001:3001 hereticjsorg/heretic:latestYou may wish to replace /var/www/heretic with any directory which shall be used to keep Heretic data on your host machine. You may also wish to replace the default port mapping (for example, to make container listen on the port 80, use the -p 80:3001 parameter).
If you want to run Heretic without containers (in standalone mode), you must make sure that all necessary dependencies (such as Node.js, MongoDB and Redis if needed) are available on your server. For automated setup, you can download an interactive script that will download the latest version of Heretic from Github and execute the necessary commands for the first start:
curl -sS -o heretic.sh https://hereticjs.org/installNext, run the script by executing the command:
bash heretic.shYou can also perform all the necessary actions yourself, taking into account the specifics of your operating system version. First, you need to clone Heretic from Github repository:
git clone --depth 1 --branch master https://github.com/hereticjsorg/heretic.gitThen, you will need to go to heretic directory, install the required NPM modules and start the build process:
npm run install-modulesWhen successful, the required modules will be downloaded to ./node_modules directory.
In order to create templates of configuration files, directories, etc., you need to run the following command:
npm run configureFinally, you may wish to run the build process:
npm run build -- --devThis command will generate your site in development mode (faster, less optimizations). In order to generate a website in production mode, run the following command:
npm run buildFinally, start your web server using the following command:
npm run serverWhen successfully, your website will be accessible at http://127.0.0.1:3001.
In order to run built-in tests, please run the following command:
npm testJest, a delightful JavaScript Testing Framework with a focus on simplicity is used here.
Heretic uses Webpack, a static module bundler for modern JavaScript applications. There are two build modes in Heretic: build-dev and build-production.
During build process, Heretic creates a ./dist directory which contains everything you need to run your website (static bundles, server script etc.). There are following stages of website build:
The following directories are deleted and re-created every time you start the build process: ./dist, ./site/.build.
In build-dev mode:
This mode is intended to prepare your website to run in production mode. It has some extra optimizations so it's slower as build-dev mode and must be used when you're ready to publish your website.
In build-production mode:
Several static assets are automatically generated during the build process: