Skip to content

MoonlightOwl/illuminator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

image

illuminator

Web interface for IRC logs from channel #CC.RU on Esper.Net.

You can find the working beta here.

installation

  1. First you will need Crystal compiler installed. Refer to this page for details.
  2. Then clone this project repository:
$ git clone https://github.com/MoonlightOwl/illuminator.git
  1. Go to the project folder:
$ cd illuminator/
  1. Download dependencies:
$ shards install
  1. Build binary file in release mode:
crystal build --release --no-debug src/illuminator.cr
  1. Now you can run ./illuminator file directly from this folder, or take ./illuminator file and ./config/, ./public/ folders anywhere you want to deploy the server.
  2. To define server port and the path to irc log files you need to change the ./config/illuminator.conf file. Example:
port:1095
path:./logs/
  1. To run illuminator server in production mode you will need to define environment variable KEMAL_ENV:
KEMAL_ENV=production ./illuminator 

contribution

Feel free to make any contributions and corrections, as this is my first Crystal project, and I don't know the language good enough.