# cgit material docker

Dockerized cgit with a responsive Material Design theme.

## Quick Start

Run the container using the following command:

```bash
docker run -d -p 80:80 igorechek06/cgit-material
```

## Configuration and Volumes

You can map local directories to the following paths inside the container to customize the instance.

### /app/repos

This is the recommended directory to store your git repositories.

### /app/www/static/

Used for storing static assets such as images.

- **Note:** When referencing these files in `cgitrc`, write the path relative to `/app/www/`.

### /app/about/

Used to store specific Markdown files for repository descriptions.

### /app/etc/cgitrc (and /app/etc/ folder)

The main configuration file. It follows the standard `cgitrc` syntax.

### /app/include

Contains HTML fragments included in the pages.

- **head.html**: Used by the `head-include` setting.
- You can also place files here for the `header` or `footer` settings defined in `cgitrc`.

### /app/filters

Contains the original cgit filters and two custom filters required for the Material theme. You can add your own custom filter scripts to this directory.

- **Usage:** Set `repo.readme=/app/about/filename.md` in your config.

### /app/www/css

Contains files for markdown syntax highlighting and color variables (`hl.css`, `md.css`, `colors.css`).

## Examples

Configuration examples are located in the `/examples` directory. This includes the configuration used for `git.igorek.dev`.