Skip to content
This repository was archived by the owner on Dec 1, 2024. It is now read-only.

tosdr/Frontpage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

CrispCMS - The new ToS;DR Frontpage

Translation status Build Status

This readme is still WIP but should cover basic requirements to install.

Update submodules

git submodule update --init --recursive
git submodule foreach --recursive git fetch
git submodule foreach git merge origin master

Requirements

Redis Server - To cache Phoenix requests

MySQL - Used for Crisp database

PHP7.4 - Self explainatory

Composer - To install required dependencies from composer.json

Shell Access - You'd need it to install plugins or setup crons

Apache2.4 - As of right now only apache is supported! Nginx may come as well

mod_rewrite - used for the .htaccess

Phoenix - We recommend running your own Phoenix instance during development so you have control over the API and you don't get ratelimited

Discourse (Optional) - Crisp is also responsible for crisp webhooks to detect if a service has been added, this is entirely optional.

Plugins

Crisp has a plugin system. More info about development can be found here:

https://forum.tosdr.org/t/374

Installation

To install Crisp please make sure you have installed all requirements.

Install Composer dependencies

from the root of Crisp execute composer install

Configure Crisp

Copy .env.example to .env and edit it according to your settings.

The GITHUB_TOKEN property is required for private repos to access metadata

Run Database Migrations

The database needs to be setup on initial clone, to do this run this command:

php bin/cli.php migrate

This will create all necessary tables, install plugins and themes.

Your instance is ready now!