Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xperseguers/sphinxdoc

Virtual machine featuring TYPO3 master and Sphinx with PDF support
https://github.com/xperseguers/sphinxdoc

Last synced: 1 day ago
JSON representation

Virtual machine featuring TYPO3 master and Sphinx with PDF support

Awesome Lists containing this project

README

        

# typo3sphinx.dev

This is a basic project to set up a TYPO3 website with Sphinx-Doc.

It includes everything you need:

- Nginx + PHP-fpm 5.5
- TYPO3 master (upcoming version 6.2 LTS)
- Python development tools to build your Sphinx environment
- LaTeX for PDF rendering (TYPO3 Share font already installed)

## Requirements

- Vagrant: http://docs.vagrantup.com/v2/installation/index.html
- VirtualBox: https://www.virtualbox.org/wiki/Downloads

## Install

Clone this repository locally:

$ git clone --recursive https://github.com/xperseguers/sphinxdoc.git
$ cd sphinxdoc
$ vagrant up

Open ``/etc/hosts`` and add

192.168.50.100 typo3sphinx.dev

Now open your browser, go to http://typo3sphinx.dev/ and follow the usual steps
to set up a blank TYPO3 website.

At the end, go to the Backend, open the Extension Manager and activate extensions sphinx
and restdoc which are already available locally.

### MySQL

* MySQL database: **typo3sphinx**
* MySQL username/password: **typo3sphinx** / **typo3sphinx**

phpMyAdmin is available on http://192.168.50.100/phpmyadmin/ (root / password)

### SSH

To connect to your machine, do:

$ vagrant ssh