FerryDocs
ConceptsServices

Names

The name of a service is part of its URL and of its address on the private network.

Edit on GitHub
NameapiPublic URLapi.localhost:8080Private networkapi:3000
One name, two addresses

The name is in the URL of the service. It is also the of the service on the . Thus you cannot change the name after you create the service.

The rules of a name

RuleValue
Length1 to 40 characters
CharactersLowercase letters, digits and -
First characterA letter
Last characterNot -
Terminal
ferry create api --repo https://github.com/you/api

Names that Ferry refuses

  • The name of a . Services and datastores share their names.
  • ferry and localhost.
  • A name that looks like a Ferry id, such as srv- and 20 hex digits.

Name or id

Each command and each API route for a service accepts its name or its (srv-…).

On this page