logo

Create your Perforce server

A project gets one Perforce server. You create it from the project's hosting page: pick a plan, give the server a name, and either press Configure (Free) or pay for the first month (Team). Then wait while it is provisioned and read its address and certificate fingerprint off the connection card. The admin password arrives separately, by email.

Before you start

  • You are an administrator of the project. Non-administrators do not see the hosting pages.
  • The project has the Source Control Hosting service. If the sidebar has no Source Control Hosting section, add the service first with the sidebar's Add a Service button, the one with the plus icon, or tick it on the Services step when you create the project.
  • You know which plan you want. Free holds 5 people; Team holds 6 to 23 and adds code review and a standby. The plans are compared on Plans, people and billing; you can move from Free to Team later.
  • You know whether the server should start empty or from Perforce data you already have. That choice is made in the form and cannot be changed afterwards.
  • For the Team plan, you have a card to hand. Payment is taken on a Stripe checkout page before the server is built.

Create the server

  1. Open Server Configuration

    In the project sidebar, expand Source Control Hosting and choose Server Configuration. The page is titled Hosting, with the sub-line Manage hosting configurations for your source control. A counter in the header shows how many servers the project has out of its limit of one: 0 / 1 hosting servers.

    Before any server exists the page reads No hosting configurations yet. Click "Add" to create a new hosting configuration.

    The Hosting page with no servers: the 0 / 1 hosting servers counter, the Add button, and the empty-state message.
    Server Configuration before a server exists.
  2. Choose Add, then Perforce

    Open the Add menu and choose Perforce. The menu also lists Git, which takes you to Build Stream's connections instead, and Diversion, which is not available yet. The menu is disabled while the project already has a server or one is being created.

    The Add menu open on the Hosting page, listing Perforce, Git and a disabled Diversion item.
  3. Pick a plan

    The form is titled Add New Hosting Configuration and opens with two plan cards. Free is selected; the other card is labelled Paid and is the Team plan. Each card lists what it includes, so you can compare them in place. Selecting a card changes only the button at the bottom of the form: Configure for Free, Continue to plan for Team.

    The Add New Hosting Configuration form with the Free card selected: 5 people, 20 workspaces total, 1 depot, 80 GB storage, Build on check-in, and Code review and High-availability standby crossed out; the Paid card beside it; the Perforce URL field; the Start fresh and Bring my server across choices; the Swarm Server preview; and the Configure button.
    The create form with Free selected.
  4. Fill in the rest of the form

    Fields on the Add New Hosting Configuration form
    FieldWhat to enter
    Perforce URLA short label for the server, such as p4. It becomes the first part of the hostname: p4 gives p4.starfall.northwind.example.com. Letters, digits and hyphens; it must start with a letter. The form rejects anything else with Must start with a letter and cannot contain spaces or underscores (_).
    AdministratorThe username of your own Perforce administrator account, for example sam. The form explains it: Your Perforce administrator account. You will get a temporary password by email and be asked to change it when you first sign in. Use this account in P4Admin and for your own day-to-day work — it is one of your seats, not an extra one. Up to 32 characters, no spaces or Perforce wildcard characters, not only digits, and not starting with dsl_, which is reserved for the platform's own accounts. The form shows the reason under the field when a name is refused, for example names starting with 'dsl_' are reserved for the platform's own accounts -- please choose another. The field appears only for Start fresh; a server you bring across keeps the administrator it already has.
    Start freshA new, empty server. Ready in about a minute. Choose this for a new project or when you will populate the depot yourself.
    Bring my server acrossCopy an existing depot onto a server we host. Choose this to migrate from a Perforce server you run elsewhere. The server is then held back until your data has been copied in, and the next screen is the migration flow. See Bring an existing server across.
    Swarm ServerRead-only. Previews the Helix Swarm address that comes with the Team plan, derived from your label: p4-swarm.starfall.northwind.example.com. On the Free plan the address is reserved but no Swarm server is created.
    The Add New Hosting Configuration form on the Free plan with Perforce URL set to p4, the Administrator field set to sam with its explanation underneath, Start fresh selected, the Swarm Server preview, and the Configure button.
    The form filled in for a fresh Free server.
  5. Configure, or continue to the plan

    On the Free plan, choose Configure. The button reads Configuring... while the request is sent, and the page moves on to provisioning.

    On the Team plan, choose Continue to plan and follow the next section.

Choose the Team plan

Two more screens stand between the form and a Team server: the plan configurator and the review. Both replace the form in place; the Back button returns to the previous screen with your choices kept.

  1. Set people and storage

    The configurator has two steppers. People (hint 6 to 23) is the number of seats you are buying; below the minimum the form says The paid plan starts at 6 people. Up to 5 is free. Storage (hint 100 GB included) starts at the included allowance and goes up in steps. At the top of the range a note reads Need more than 23 people? We'll set that up for you. with a Contact us link.

    A quote updates as you change either value and ends with Monthly total. Press Continue.

    The plan configurator: a People stepper set to 6 with the hint 6 to 23, a Storage stepper set to 100 GB with the hint 100 GB included, a quote with the per-person line and the monthly total, and Back and Continue buttons.
    The plan configurator with the smallest Team plan.
  2. Review and pay

    The review is headed Perforce server for starfall and lists the people line, the storage line (Included while you are within the allowance), Total per month and First charge today. A note reads Your server is created after payment. It takes a few minutes.

    Press Pay and create server. The button reads Taking you to payment… and the browser goes to a Stripe checkout page for the card details. Nothing is built until Stripe confirms the payment.

    The review screen: Perforce server for starfall, 6 people times the per-person price, 100 GB storage marked Included, Total per month, First charge today, the note that the server is created after payment, and Back and Pay and create server buttons.
    The review screen. The amounts are examples.

After you pay

Stripe sends you back to the hosting page, which now shows a checklist titled Setting up your Perforce server:

The Setting up your Perforce server checklist
StepWhile it runsWhen it is done
Confirming paymentWaiting for Stripe to confirm. This takes a moment.Payment confirmed: Thanks — your card was charged.
Building your serverA real machine is allocated and licensed. This usually takes a few minutes.The step is ticked.
ReadyConnection details appear here. The Perforce is ready email tells you how to sign in as your administrator; add your team in P4Admin with that account.The checklist is replaced by the connection card.
The Setting up your Perforce server checklist with Payment confirmed ticked, Building your server in progress, Ready still to come, and the note You can close this page. We'll email you when it's ready.
Payment confirmed; the server is being built.

You can leave: the page says You can close this page. We'll email you when it's ready. The redirect back from Stripe is not what confirms payment; the checklist waits for Stripe's own confirmation, so the first step can stay open for a moment even though you saw a success page.

If the platform cannot finish building the server, the checklist is replaced by an explanation: Your payment went through, but we couldn't finish setting up your server. We've been notified and will fix it. You won't be charged again. followed by the reason. Once automatic retries are exhausted a Retry setup button appears; press it to try again yourself (a notification reads Retrying setup).

The failure state of the setup checklist: the sentence that the payment went through but setup could not finish, a reason line, and a Retry setup button.
Setup failed after payment. You are not charged again.

While it provisions

Accepting the form queues the work; it does not build the server. Provisioning allocates hardware, issues the TLS certificate and creates the admin accounts. On the Free plan the page shows a status banner while it runs: Your Perforce server is being created. Waiting for project source control to finish provisioning. On the Team plan the checklist above plays the same role.

You can leave the page. When the server is ready you get a notification titled Service ready (Source Control Hosting is now available in the sidebar.), and the connection card below replaces the banner.

Your connection details

Once the server is up, the Project source control card shows what your team needs to connect. Each row has a Copy button. Above the rows the card repeats a one-line summary of your plan; on the Free plan it ends with The free plan holds 5 people.

Rows on the Project source control card
RowExampleUse it for
Perforce Serverssl:p4.starfall.northwind.example.comThe server address, already carrying the ssl: prefix.
Port1031The port assigned to your server when it was created; yours will differ from this guide. Address and port together are your P4PORT.
FingerprintAB:12:6D:4F:90:C3:E8:71:2A:55:BD:04:7E:39:F1:C8:6B:2D:A0:14The TLS certificate fingerprint. Compare it when you first connect; if it does not match, stop.
Swarm Serverp4-swarm.starfall.northwind.example.comHelix Swarm, for code review, once you have turned it on (Team plan). Sign in with your Perforce account.
The Project source control card on a Free server: the one-line plan summary, then Perforce Server, Swarm Server, Port and Fingerprint rows, each with a Copy button.
The connection card on the Free plan.
The Project source control card on a Team server: the one-line plan summary, then Perforce Server, Swarm Server, Port and Fingerprint rows with Copy buttons.
The connection card on the Team plan.

Your team connects with the hostname and port joined into a TLS address:

P4PORT
ssl:p4.starfall.northwind.example.com:1031

How to trust the certificate, sign in and change the admin password is on Accounts, security and licensing. Below the card sit the Build on check-in card, the Code review (Swarm) card, the People panel and, on the Team plan, the Billing panel; each has its own section in this guide.

The email with your admin password

When the server is ready, the project maintainer receives an email with the subject Perforce is ready for Starfall, using the project's display name. It repeats the server address and fingerprint and carries the one thing the app never shows: the temporary password for the administrator account you named on the form.

Contents of the Perforce is ready email for a fresh Free server
In the emailExample
Serverssl:p4.starfall.northwind.example.com:1031
SSL fingerprintAB:12:6D:4F:90:C3:E8:71:2A:55:BD:04:7E:39:F1:C8:6B:2D:A0:14
Usernamesam, the administrator name you chose
PasswordA temporary password. Perforce asks you to choose your own the first time you sign in.
How to add your teamOpen P4Admin, connect it to the server, sign in as sam. See below.
Your planThe free plan holds 5 people in total, sam included. To add a sixth, move to a paid plan from the Hosting page.
Our accounts on your serverdsl_admin, our operator account for looking after the server, and dsl_bot while Build on check-in is on.
The Perforce is ready email: server address, SSL fingerprint, a warning to verify the fingerprint, the username sam, a masked temporary password, the paragraphs explaining that sam is the administrator account and that the team is added in P4Admin, the free plan sentence, and the paragraphs about the dsl_admin and dsl_bot accounts.
The ready email for a fresh Free server, with the password masked here.

The email says Verify the fingerprint above before trusting the connection and, of the account: sam is your administrator account, and it is a full member of the team: use it for your own day-to-day work, and to add people and set what they can reach. Then: To add your team, open P4Admin — Perforce's administration tool — connect it to the server above, and sign in as sam. P4Admin is installed together with P4V; see Install the Perforce tools and Add your team in P4Admin.

On the Team plan the same email says Your plan holds the seats you bought, sam included. A server you brought across gets no new account: the email tells you to sign in with the Perforce administrator account you already use, because your users and passwords came across with your data.

Sign in as the administrator you named; do not create a new user for yourself first. In P4V that means Connection → Open Connection with the user set to that name. The Connection Setup Assistant's Create a new user account option fails with User type can't be changed, because the account already exists.

Retiring a server

There is no delete button on the hosting page. Retiring a Perforce server is done by our team, so that a server holding your history cannot be removed by an accidental click.

Next steps

Something out of date or unclear? Email support@devstreamlabs.com.