Scratch Copy is a project to build a tool that allows uploading and downloading assets in order to share them on the Internet by using generated short links.

Scratch Copy can be found in the Wizardry and Steamworks SVN repository. You can checkout the entire project by issuing the command:

svn co http://svn.grimore.org/scratch

to a local directory.

The project has server-side requirements for serving the pages and client-side requirements for interacting with Scratch Copy.

• Apache 2.4 with the xsendfile module enabled.
• PHP version 5.6 and above.

The client requires a modern web-browser, with JavaScript enabled and the ability to accept cookies. Scratch Copy uses cookies to set parameters - such as remembering the state of the sound toggle on the main page.

• Create a virtual host and a folder to contain Scratch Copy. As an example, the following configuration file creates a virtual host for the fictive domain scratch.cpy:

<VirtualHost *:80>
        # The web administrator E-Mail
        ServerAdmin admin@scratch.cpy
        # The domain name.
        ServerName scratch.cpy
 
        # Scratch Copy requires the XSendFile module to be enabled.
        XSendFile On
        # The path to the directory where files will be uploaded.
        # Preferably, this path should be outside the document root.
        XSendFilePath /var/www/incoming
 
        # The path to the directory where the Scratch Copy scripts
        # and files will reside.
        DocumentRoot /var/www/scratch.cpy
        <Directory /var/www/scratch.cpy>
                Options FollowSymLinks
                # Scratch Copy comes with a custom .htaccess file
                # such that this option would be enabled.
                AllowOverride All
                Order allow,deny
                allow from all
        </Directory>
 
        # The directory where the files are uploaded should not
        # allow Apache to create directory indexes and should 
        # not be able to be browsed directly.
        <Directory /var/www/incoming>
                Options -Indexes
        </Directory>
 
        # These are set by Apache and configure the path to the log files.
        ErrorLog ${APACHE_LOG_DIR}/scratch.cpy-error.log
        CustomLog ${APACHE_LOG_DIR}/scratch.cpy-access.log common
</VirtualHost>

• Checkout the source in the folder you have created:

svn co http://svn.grimore.org/scratch .

• Copy config.yaml.default to config.yaml and edit the file to make configuration changes.

The following configuration keys are necessary:

• The STORE_FOLDER variable should be set to a different folder, preferably outside of the root of the website and the folder must be writeable by the user that the webserver runs under.
• URL_PATH should be set to the URL of the website you are hosting.