Giter Site home page Giter Site logo

mraro's Introduction

Welcome to mrAro

mrAro is a website muncher for Linux. It feeds on Markdown text files, digest them through PHP templates and "produces" steaming hot, fully formed webpages.
mrAro includes a drag-and-drop menu manager, a text editor with markdown live preview and a simple caching system.

Install

To install, pick a folder on your server and clone the repo from GitHub:

cd /www/mysite-folder
git clone https://github.com/bergamote/mraro.git .

Then go to the folder mra/admin and run the init script:

cd mra/admin
./mra_init

This will create:

  • the content folder with a couple of example pages
  • the settings files (mra.conf and menu.conf)
  • an empty cache directory (mra/tmp)

Make sure that the server's PHP has permission to write in content and mra/tmp.

Credentials

Edit the hidden file mra/.creds, keeping the first line for your username and the second one for your password. By default it looks like this:

user
pass

Important

You must tell your server to deny access to hidden files from the outside (or at least to the .creds file). To do that, follow the instructions here.

Editing the theme

The template and CSS are located in the mra/theme/default folder. To edit the theme, first make a copy of the default folder.

cp mra/theme/default mra/theme/my-theme

Then in mra/mra.conf, edit the theme line replacing default by the name of your new theme (here my-theme).

Dependencies

mrAro comes packaged with the following programs:

mrAro and its dependencies, as far as I can tell, are released under the MIT License.

mraro's People

Contributors

bergamote avatar

Stargazers

 avatar

Watchers

 avatar

mraro's Issues

Image linking broken

Since the nginx_url commit, and when that setting is disabled, linking images with ?i=file.jpg doesn't work.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.