Configuring a SourceCraft repository to support Git Large File Storage (LFS)

SourceCraft repositories support Git Large File Storage (LFS) for storing large files. We recommend using LFS for storing objects larger than 100 MB in the repository.

1. Clone the SourceCraft repository:

   HTTPS

   SSH

   1. Install Git.

   2. In the top-right corner of the repository page, click Clone.

   3. Copy the link for cloning the repository from the HTTPS field.

   4. In the terminal, run this command:

      git clone <link_for_cloning_repository>
      

   5. Enter a username.

   6. Specify the personal token as the password.

      Tip

      If you do not want to enter your username and password every time, use the following command:

      git clone https://anyname:<personal_access_token>@git.sourcecraft.dev/<organization_slug>/<repository_slug>.git
      

   7. Go to your cloned repository:

      cd <repository_name>
      

   1. Install Git.

   2. In the top-right corner of the repository page, click Clone.

   3. Copy the link for cloning the repository from the SSH field:

   4. In the terminal, run this command:

      git clone <link_for_cloning_repository>
      

      Warning

      Before confirming your first SSH connection, verify the server’s key fingerprint. This helps you detect server spoofing. If the fingerprints mismatch, cancel the connection and contact support.

      To clone the repository via port 443, specify the port number in the URL:

      git clone ssh://ssh.sourcecraft.dev:443/<organization_slug>/<repository_slug>.git
      

      Here is an example:

      git clone ssh://ssh.sourcecraft.dev:443/sourcecraft/sourcecraft.git
      

      For more information on using SSH over HTTPS, see this GitHub guide.

   5. Go to your cloned repository:

      cd <repository_name>
      

2. Install git-lfs:

3. Configure your repository to support LFS:

   git lfs install
   

4. Copy the files you want to store in LFS into the repository.

5. List the files for LFS storage, separating them with spaces:

   git lfs track "<path_to_large_file_1>" "<path_to_large_file_2>" "<path_to_large_file_n>"
   

   Tip

   You can also specify file templates to store in LFS, e.g., git lfs track "*.png"

6. Stage the files in Git, create a commit, and push the changes to the remote repository:

   git add .
   git commit -m "added LFS objects"
   git push origin main
   

Useful links

• SourceCraft resource relationships
• Importing a repository
• Making a pull request