Skip to content

Commit

Permalink
Add more documentation in the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
intelligide committed Nov 17, 2023
1 parent d094716 commit e4417b0
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,35 @@
# HelixCoreServerPackage
# Helix Core Server Package for Synology

Perforce Helix is a full-featured VCS that scales to thousands of users and millions of files, which allows you to maintain software source code, documents, or any type of file.

## To create a Perforce server:

## Requirements

- DSM >= 7.0
- Synology NAS with a x86_64 processor

## Downloading the package

Download the .spk package corresponding to your NAS in [the Releases page](https://github.com/FrozenStormInteractive/Perforce-Synology/releases).

Packages have names containing the information you need to choose which one to install:
```
HelixCoreServer-<Perforce server version>-<Package version number>-<Processor architecture>-<DSM version>.spk
```

For example, the package with number 0025 containing P4D 23.1 for Synology NAS with x86_64 processor and DSM 7.1 has the name `HelixCoreServer-23.1-0025-x86_64-7.1.spk`.

## Installing the package

- Go to the DSM Package Center
- At the top left of the Package Center window, next to the search bar, click on the "Manual install" button.
- Select the spk file you have downloaded
- Follow the instruction of the installer
You msut create a perforce server now.

Once installed, you need to create a Perforce server.

## How to create a Perforce server:
1. Sign in to DSM using an account with administrative privileges.
1. Go to **Control Panel** > **Terminal & SNMP** > **Terminal** then enable **SSH service**.
1. (Optional) Go to **Control Panel** > **Shared Folder** and create a shared folder for Helix Core server repositories.
Expand All @@ -27,3 +54,13 @@ Perforce Helix is a full-featured VCS that scales to thousands of users and mill
```
sudo -u Perforce p4dctl-ng new
```

## Upgrading the package

- Download the newest version in [the Releases page](https://github.com/FrozenStormInteractive/Perforce-Synology/releases).

:warning: You must take a package with a higher perforce server version than your current one, or a higher package number than your current one. The perforce server is not backward-compatible.
- Go to the DSM Package Center
- At the top left of the Package Center window, next to the search bar, click on the "Manual install" button.
- Select the spk file you have downloaded
- Follow the instruction of the installer.

0 comments on commit e4417b0

Please sign in to comment.