Blog | Roadmap | Browse Source | View Tickets | Register | Trac Login | Forgot Password?

Setting up an ICE repository

What is an ICE repository?

An ICE repository is a Subversion repository with additional directories: .site, skin and templates.

.site
Tells ICE how to structure the folders within the repository. The site.py in the site folder is formatted to define a package.

/.site/site.py

skin
Contains the XHTML templates, CSS and other common media used format the HTML render. A default skin is built-in for version 2.0 and can be customized.

/skin/

templates
Files stored here are used for creating new documents in ICE.

/templates

Creating an ICE repository

For more detailed information about Subversion repositories see the Subversion website at http://subversion.tigris.org.

  1. Create a repository by typing the following in the command line where you wish to create the subversion database for file storage.

    svnadmin create $repository-name
  2. Checkout the repository :

    1. To checkout a repository over a network:

      svn co file://$full-path/$repository-name $name
    2. To check a repository via a HTTP request:

      svn co http://$domain/svn/$repository-name $name

ICE repository config URL

An ICE config URL is a special URL that tells ICE what the settings are for the given repository, for example:

http://localhost:8000/edit-config?
url=https://ice.usq.edu.au/svn/ice/trunk/sample-content
&name=ice-sample&save 

The base URL is http://localhost:8000?edit-config you add the given parameters as specified in the table below.

Parameter

Description

Default value

url

The SVN location of the repository folder that contains the .site and skin folders

n/a

name

Folder name of the content to checkout the content into.

Ending folder name of the url eg http://..../sample is sample

path

The path is the location where you want the content checkout to on your system.

~ (Tilde) can be used for the users home directory, e.g. ~/ICE/sample-content

Windows
c:/ice/$name

Mac
/Users/$username/$name

Linux
/home/$username/$name

template-path

The directory where the templates are located relative to the path

/templates

export-path

Where the content is exported, and is an absolute path.

~ (Tilde) can be used for the users home directory, e.g. ~/ICE/sample-content/exports

Windows
c:/ice/$export-path

Mac
/Users/$username/$export-path

Linux
/home/$username/$export-path

save

This parameter automatically saves the repository configuration and reloads ICE

n/a

* $username The username used to log onto the operating system

previous up next