Skip to content

How to install

Frédéric Druppel edited this page Oct 3, 2022 · 6 revisions

Dependencies

  • NPM

FolderCMS was written in Javascript and runs with NodeJS. First, clone this repo on your computer/server and install dependencies :

git clone https://github.com/fred-corp/folderCMS

cd folderCMS

mkdir website

The last command creates a website folder at the root of folderCMS, in which you should add your webpages. You can find example websites in the website-examples folder.

Run with Node.JS

Launch the server with NodeJS !

npm install

node server.js

Note : Alternatively, you can use npm ci to install dependencies from the lock file.

npm ci

node server.js

Run with Docker

You can also run FolderCMS with Docker. First, build the image :

docker build . -t foldercms

Then, run the container with linked port 3000, linked directory website and linked directory config :

docker run -d -p 3000:3000 -v /path/to/website:/app/website -v /path/to/config:/app/config --name FolderCMS-site foldercms

Accessing the website

If everything went right, the website should be accessible on localhost:3000, or (more likely) <your-server-ip>:3000 !
As a good practice, the NodeJS app / Container should be placed behind a load balancer like nginx.