Setup and Configuration - archimatetool/archi-modelrepository-plugin GitHub Wiki

Setup

  1. Download the Archi plug-in zip file from the Archi plugins page
  2. In Archi, select "Manage Plug-ins..." from the main Help menu. From the Plug-ins Manager window, select "Install New..." and select the plug-in file and then, when prompted, allow Archi to restart
  3. The "Collaboration" menu should now be visible

Configuration

You can access the configuration options through Archi's Preferences.

collab_preferences

Global User Details

Every commit is signed with your identity. This identity comprises your name and your email. Set them as per your requirements.

Note that you can't change the signature of a commit!

Workspace

The Collaboration Workspace folder is by default located in Archi's home folder. This folder contains local copies of all the models that you have in your workspace. In some aspects, it is your workspace. You can change this location if required.

If you want the models to refresh in the background, set this here. Background fetch allows Archi to automatically get remote updates to update model status.

Authentication

For all actions a primary password is required. You can set or change this here. This primary password secures an encryption key that is used to encrypt all other passwords - passwords for each repository, the password that secures the SSH identity (if used) and the password that secures the Proxy settings (if used).

SSH - if using SSH repositories set the path to the identity file and password here. If using more than one SSH key select the option to scan the ~/.ssh folder for SSH keys, this allows more than one SSH key for different remote hosts. Note that the identity password must be the same for all key files. See SSH Authentication for more details.

HTTP - If not enabled you will be prompted for your credentials each time you have to connect to a server (i.e. when refreshing or publishing a model). You can enable this option if you want a seamless experience.

Proxy

If the models you work with are stored on a server which is behind a web proxy, you can configure that here.

Note that if proxy support is enable it will be used to connect to all of your models.

TLS (SSL) Troubleshooting

Some git repositories are hosted by servers that have certificates that the JRE used by Archi cannot verify. This is because the JRE certificate store does not have a complete certificate chain for these servers. This is the case when companies have issued their own certificates.

A temporary work around to see whether this might be the case is to disable certificate verification by editing the git config file, either globally or just for the local repository. The global location is C:\Users\[username]\.gitconfig, and the following settings will disable SSL verification:

[https]
	sslVerify = false
[http]
	sslVerify = false