Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakobbouchard/helix-core-server
A simple image to run a Helix Core Server (Perforce)
https://github.com/jakobbouchard/helix-core-server
Last synced: about 1 month ago
JSON representation
A simple image to run a Helix Core Server (Perforce)
- Host: GitHub
- URL: https://github.com/jakobbouchard/helix-core-server
- Owner: jakobbouchard
- License: mit
- Created: 2024-05-10T20:50:35.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-11T20:06:08.000Z (4 months ago)
- Last Synced: 2024-07-11T23:04:55.365Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> I found [this better image by hawkmoth-studio](https://github.com/hawkmoth-studio/perforce-docker). Please use this one instead!
# Helix Core Server
This image provides a simple way to get started with a Helix Core Server (Perforce).
## Usage
### Docker Compose without SSL
```yaml
services:
perforce:
image: jakobbouchard/helix-core-server:latest
ports:
- "1666:1666"
environment:
P4ROOT: /opt/perforce/root
P4SSLDIR: /opt/perforce/ssl
P4JOURNAL: /opt/perforce/journals/journal
P4PORT: 1666
volumes:
- ./data:/opt/perforce
restart: unless-stopped
```
### Docker Compose with SSL
```yaml
services:
perforce:
image: jakobbouchard/helix-core-server:latest
ports:
- "1666:1666"
environment:
SSL_COUNTRY: CA
SSL_STATE: Quebec
SSL_LOCALITY: Montreal
SSL_ORGANIZATION: Organization
SSL_ORGANIZATIONAL_UNIT: DevOps
SSL_COMMON_NAME: localhost # must be a valid hostname
SSL_EXPIRY: 365 # days
P4ROOT: /opt/perforce/root
P4SSLDIR: /opt/perforce/ssl
P4JOURNAL: /opt/perforce/journals/journal
P4PORT: ssl:1666
volumes:
- ./data:/opt/perforce
restart: unless-stopped
```
### Post-install configuration
Helix Core Server does not create a user by default. You will want to connect to the container's shell and run the following to create your first user:
```
p4 user -f
```
Once that's done, login using [P4Admin](https://www.perforce.com/downloads/administration-tool) and enter your server URL (e.g. `ssl:localhost:1666` and your username. Once that's done, it will ask you if you want to be the sole super-user. Click **Yes**, then restart P4Admin, it should reconnect to the server and you'll see your server info and be able to manage it now.
### Configuring a cron job
I highly recommend setting up a cron job on your host OS that looks something like the following, so that your journals are rotated and checkpointed.
```
0 0 * * 1-6 docker exec perforce bash /app/rotate-journal.sh
0 0 * * 0 docker exec perforce bash /app/checkpoint-journal.sh
```
## DO NOT UPGRADE THE SERVER IN-PLACE EVER
Please follow the [Perforce instructions](https://www.perforce.com/manuals/p4sag/Content/P4SAG/chapter.upgrade.html) and then start the container. I am not responsible for any loss of data that may occur, and you should **always** have proper backups.