/Dazzle

A script to easily set up a SparkleShare host on Debian, Red Hat or Synology systems.

Primary LanguageShell

# Dazzle and DazzleDS, SparkleShare host setup script

An easier and less error prone way to set up a SparkleShare host.
Dazzle was created to work on Debian and Red Hat based systems.
DazzleDS was created to work on Synology NAS systems.


## Dazzle Usage

Usage (as root):

    # Get Dazzle
    curl https://raw.github.com/hbons/Dazzle/master/dazzle.sh \
        --output /usr/local/bin/dazzle
    
    # Initial Dazzle setup
    chmod +x /usr/local/bin/dazzle
    dazzle setup

    # Link a SparkleShare client
    dazzle link

    # Create a new project
    dazzle create PROJECT_NAME


## DazzleDS Preperation

Before you can use DazzleDS with your Synology NAS you have to do some preperations within the DSM at first:

    # Create a DSM user called "storage"
    Control Panel -> User -> Create

    # Activate the user home service
    Control Panel -> User -> Advanded Tab -> Enable user home service
    
    # Install the Git Server Package from the DSM Package Center
    Package center -> Utilities -> Git Server -> install

    # Grant the DSM user "storage" the rights to use the git server
    Git Server -> Check "allow access" for the storage user


## DazzleDS Usage

Usage (as root):

    # Get DazzleDS
    curl https://raw.githubusercontent.com/christian-putzke/Dazzle/master/dazzleDS.sh \
        --output /usr/local/bin/dazzleDS
    
    # Initial DazzleDS setup
    chmod +x /usr/local/bin/dazzleDS
    dazzleDS setup

    # Link a SparkleShare client
    dazzleDS link

    # Create a new project
    dazzleDS create PROJECT_NAME


## Configuration

You can control almost all configuration options via environment variables:

    export DAZZLE_USER=dazzle
    export DAZZLE_HOME=/var/lib/stuff
    sudo dazzle setup

Available options are the following:

* DAZZLE_USER: the Dazzle user. Defaults to "storage".
* DAZZLE_GROUP: the Dazzle group. Defaults to "storage".
* DAZZLE_HOME: the directory used to store projects. Defaults to "/home/storage".

The following options are additionaly and only available within DazzleDS
* DAZZLE_STORAGE: the directory used to store projects. Defaults to "/home/storage".
* DAZZLE_HOST: the host that is used within ssh link displayed after creating a project. Defaults to "/etc/hostname"