Project Creation with Remote Repositories
Crafter Studio supports project creation with remote repositories and provides two options:
- Create project based on remote Git repository
- Create project based on a blueprint then add a remote Git repository
To start creating a project with remote repository, from the Projects screen, click on the Create Project button. A Create Project dialog will be launched. For both options, there will be a screen where the Remote Git Repository Name and Remote Git Repository URL needs to be filled out and the rest is optional and only needs to be filled out if required by the remote git repository being used.
Let’s take a look at the fields where the remote repository details needs to be filled in:
In the Git Branch field, you can supply a branch name, but can be left blank, which in turn would default to the
In the Git Repo URL field you must provide the link to the Git repository you would like to use
In the Git Remote Name field you want to provide a repository name that makes sense. It’s common to use “origin” or “upstream.”
In the Authentication field you must select the authentication method to be used to access the Git repository in the previous field.
CrafterCMS supports the following authentication types to use to access remote repository:
- Authentication not required (Public URL) - no credentials needed to access remote repository
- Username & Password - for this method, you will be asked for a Remote Git Repository Username and a Remote Git Repository Password. Supply your username and password
- Token - for this method, you will be asked for a Remote Git Repository Username (if required) and a Remote Git Repository Token. This method is usually used when two-factor authentication is configured on the remote repository to be accessed. Supply your username if required and token.
- Private Key - for this method, you will be asked for a Remote Git Repository Private Key. This method is a key-based authentication. Supply your private key.
Create project based on a blueprint then add a remote bare Git repository
To create a project based on a blueprint then add a remote bare git repository, click on Create Project from Projects, then select the blueprint you would like to use
The next step is to fill in the Project ID and Project Name, then click on the Review button, then finally click on the Create Project button to create your project. Your project should be created in a short while.
Once your project is created, the next step is to add a remote repository to your newly created project. Open the Sidebar then click on Project Tools -> Git, then click on the New Remote on the top right. This will open up a dialog where we can fill in all the information for our remote repository as described above. Click on the Create button after filling in the required information.
Your project should now have a remote repository listed in the Remote Repositories tab of the Git screen
Remember that the remote repository needs to be a bare git repository, since we are pushing our newly created project to the remote repository. To push our newly create project to the remote repository, click on the
Push button (button with the up arrow) next to the remote repository
Create project based on a remote Git repository
Creating a project based on a remote Git repository is basically exporting a project from one Studio and importing it into another one.
To create a project based on remote Git repository, after clicking on Create Project, Click on Remote Git Repository in the Private Blueprints tab create project screen
Click on the Project ID field where you’ll need to give your project an ID. Scroll down to see where you can fill in all the information for the remote repository we are importing. The
Git Repo URL is the import project’s sandbox repository git url (the project you want to bring over to your Studio). Below are sample urls for the project being imported:
Here is a sample Git url from GitHub: https://github.com/username/hello-test.git Here is a sample Git url using ssh: ssh://[user@]host.xz[:port]/path/to/repo/ or alternatively for ssh: [user@]host.xz:path/to/repo/
Click on the Review button, then finally, the Create Project button.
After a short while, your project will be imported.
In case you want to publish the entire project, follow these optional steps:
In the project you just imported, click on Project Tools, then click on Publishing
In the Publishing screen, scroll down to
Publish on Demandthen click on the Publish Entire Project button to publish the whole project.