<commit_before># HashBrown CMS

A free and open-source headless CMS built with Node.js and MongoDB

![HashBrown CMS](http://hashbrowncms.org/img/screenshot.jpg)

## Getting started
- [Guides](https://hashbrowncms.org/guides)
- [API documentation](https://hashbrowncms.org/docs/api/)
- [Developer documentation](https://hashbrowncms.org/docs/src/)

## Docker

The easiest way to get up and running is to use the HashBrown CMS [Docker](https://hub.docker.com/r/hashbrowncms/hashbrowncms/tags) images.

Example `docker-compose.yml` setup:

```yaml
version: "3.4"

networks:
    example--network: ~
    
services:
    cms:
        image: hashbrowncms/hashbrowncms
        container_name: "example--cms"
        ports:
            - 8080:8080
        depends_on:
            - mongodb
        networks:
            - example--network
        restart: unless-stopped
        environment:
            - MONGODB_HOST=mongodb
        volumes:
            - "./storage:/srv/app/storage" # For content and media
            - "./plugins:/srv/app/plugins" # For custom code

    mongodb:
        image: mongo
        container_name: "example--mongodb"
        networks:
            - example--network
        restart: unless-stopped
        volumes:
            - "./db:/data/db"

    website:
        image: node
        command: node /srv/app/src/index.js
        ports:
            - 80:80
        volumes:
            - "./website:/srv/app/src" # The website server code
            - "./storage/website/live/content:/srv/app/content" # Content files to be presented by the website
            - "./storage/website/live/media:/srv/app/public/media" # Public directory for media files
```

## Installing HashBrown

First make sure you have these dependencies met:  
- node.js
- mongodb
- imagemagick
- optional:
  - docker & docker-compose
  - nodemon

Then clone the code and install the dependencies:  
```
git clone https://github.com/HashBrownCMS/hashbrown-cms.git --recursive
cd ./hashbrown-cms
npm install
```

## Running HashBrown

Building and starting the server for production:<commit_msg>Updated readme to include Docker image documentation<commit_after># HashBrown CMS

A free and open-source headless CMS built with Node.js and MongoDB

![HashBrown CMS](http://hashbrowncms.org/img/screenshot.jpg)

## Getting started
- [Guides](https://hashbrowncms.org/guides)
- [API documentation](https://hashbrowncms.org/docs/api/)
- [Developer documentation](https://hashbrowncms.org/docs/src/)

## Docker

The easiest way to get up and running is to use the HashBrown CMS [Docker](https://hub.docker.com/r/hashbrowncms/hashbrowncms/tags) images.

Example `docker-compose.yml` setup:

```yaml
version: "3.4"

networks:
    example--network: ~
    
services:
    cms:
        image: hashbrowncms/hashbrowncms
        container_name: "example--cms"
        ports:
            - 8080:8080
        depends_on:
            - mongodb
        networks:
            - example--network
        restart: unless-stopped
        environment:
            - MONGODB_HOST=mongodb
        volumes:
            - "./storage:/srv/app/storage" # For content and media
            - "./plugins:/srv/app/plugins" # For custom code

    mongodb:
        image: mongo
        container_name: "example--mongodb"
        networks:
            - example--network
        restart: unless-stopped
        volumes:
            - "./db:/data/db"

    website:
        image: node
        container_name: "example--website"
        command: node /srv/app/src/index.js
        ports:
            - 80:80
        volumes:
            - "./website:/srv/app/src" # The website server code
            - "./storage/website/live/content:/srv/app/content" # Content files to be presented by the website
            - "./storage/website/live/media:/srv/app/public/media" # Public directory for media files
```

## Installing HashBrown

First make sure you have these dependencies met:  
- node.js
- mongodb
- imagemagick
- optional:
  - docker & docker-compose
  - nodemon

Then clone the code and install the dependencies:  
```
git clone https://github.com/HashBrownCMS/hashbrown-cms.git --recursive
cd ./hashbrown-cms
npm install
```

## Running HashBrown

Building and starting the server for production:
{'fraction_non_alphanumeric': 0.11426560300328484, 'fraction_numerical': 0.00656968559361802, 'mean_word_length': 2.2868157286044717, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '389469', 'n_tokens_mistral': 1381, 'n_tokens_neox': 1248, 'n_words': 319}