Join GitHub today
#UpStage Server Manual: v3.4.7
You may want to switch into root to perform following dependency installation processes.
1. Dependencies Installation
- For UpStage dependencies installation and environment setup : see Dependencies Installation
2. Download the UpStage source package from GitHub
- For release versions: see Release page
- For development versions: clone the master branch or download the zip file
3. Extract the package to a desired location
The full system path to the destination folder should not contains any spaces. For example, the path
/home/johndoe/awesome projects/UpStage contains a space, so the folder
awesome projects should be renamed to
4. Open Terminal and navigate to the client source folder
5. Use the
install.py script to perform desired actions:
python install.py ccto recompile the client.swf file.
mtascmust be installed on the system. If you just downloaded UpStage from GitHub, client.swf is provided, but if any development activities using
anthave been done, the client.swf will be need to be recompiled.
UpStage Server Deployment Methods
UpStage provides 2 methods to perform server deployment on Debian 7 server.
Under the downloaded UpStage source directory execute:
python install.py # consolidate files into an independent build folder
once UpStage is installed, then
cd dist #the portable UpStage directory
You may want to edit
config.py file under 'dist/upstage' in the new generated instance directory. From the line 32 - 34, you can choose your preferable service ports.
Before making the instance running, you may also want to rename the 'dist' folder and move the folder to a desirable path, so that different server instances can distinguish from one another.
For completing demonization process, execute under 'dist'(or the instance folder with your preferred name)
Once all the commands done, UpStage instance shall run as a background process on Debian.
You will need to make sure all UpStage dependencies are installed. Please see Dependencies Installation
Now the daemonization process completed. Please follow the [Server Management] (https://github.com/AUTUpStageTeam/UpStage/wiki/Server-Manual#server-management)
Development Ant Targets
This method only consumes server's RAM as storage. It is ideally for the dedicated UpStage server at AUT.
Before the next few steps, we need to modify configuration file to set up preferred service ports:
under the downloaded UpStage source folder, use your preferred text editor to open
Once the step 5 is completed, execute code below should bring up UpStage instance with predefined properties. Such properties can be modified in 'build.properties' under the root path of UpStage project folder.
You may modify line 18-20 to change the service ports.
Then under UpStage source root folder, enter
Now an UpStage instance shall be available when user enters the server's ip address with identified service port. For instance, 192.168.1.254:8081
UpStage provides the
upstage-backup script to create a backup of UpStage's media and configuration files. You can execute
sudo upstage-backup manually at any time, but UpStage also creates a cron job to do it automatically every week during installation. The backup .tar files will be created in
/home/UpStage Media Backup folder.
From 3.4.7, UpStage only uses the build directory for server deployment. To uninstall UpStage, server admin only needs to stop the current running instances, then remove the "dist" directory.
Terminal Guide: Basic Commands
ls [directory]to list files and directories in a directory or just
lsto list the current directory
cd [destination]to change current working directory
cd ..to go up a directory
mkdir [new directory name]to create a new directory
Tip: When typing an existing directory name, you can type the first few characters and hit
tab to autocomplete its name.