Advanced configuration

Import users


If you want to import lots of users without bothering about GUI you can do this by preparing a CSV that looks like this:
 

Username E-Mail Password License
user01 user01@acme.com user01 M
user02 user02@acme.com user02 M
user03 user03@acme.com user03 M
user04 user04@acme.com 4f7jkz
user05 user05@acme.com secret V
user06 user06 V
user07 user07@acme.com user07 V
user08 user08@acme.com user08 V
user09 password N
user10 user10 N


Here are some remarks on the list format:
  • Accepted column separators are ";" or "," or "TAB", whichever is found first. But the entire CSV file needs to use the same separator.
  • The first line is mandatory, it is used for parsing the fields.
  • Entries in the column Username are mandatory.
  • Entries in the column E-Mail are optional.
  • Entries in the column Password are mandatory.
  • Entries in the column License are optional. Unset values are assumed as M. Possible license values are M for multi-user license, V for viewer license and N for no license.
  • If you want to use characters that are not covered by codepage 1252 you need to encode the CSV file with UTF8 and add the additional commandline parameter"/useutf8" when starting "ArticyServer.exe" (see below).

Once this list is prepared:
  • Open "Service manager"
  • Stop the service "articy:server"
  • Open a command line (cmd.exe) and use 'cd /d "%ProgramFiles%\articy server\server"'
  • Issue the command "ArticyServer.exe /con /importusers Users.csv". --> Server should echo a line for any user that is imported.
     
    The CSV file can be read from anywhere, just specify the fully specified URL/filename of the list file
  • After that hit "CTRL-C". --> The server stops and the user returns to the command prompt.
  • "EXIT" the command prompt --> Command line window closes.
  • Switch back to "service manager" and start the "articy:server" service again.


ClientSettings.xml


It may prove useful for a server administrator to define certain default settings or even restrictions for all articy:draft users who connect the the articy:server. In order to achieve this, the file ClientSettings.xml can be found in the installation directory of the articy:server. This file is an ordinary XML file. It is read by articy:server every time a new user logs in. This means, that changes to this file do NOT require a restart of the server.

Currently ClientSettings.xml supports:
  • Preselection and/or forcing of SCM provider
  • Preselection and/or forcing of SVN repository paths (local, remote and prefix)
  • Preselection and/or forcing of Perforce depot paths (host, port and prefix)

Editing ArticyServer.cfg


Advanced configuration is done by editing the file ArticyServer.cfg in the directory \server inside the installation directory of your articy:server. These settings are only read when starting the service so you need to restart the service to force the settings to take effect.

Listening port


If you need to change the listening port to another value, change the value of the -listenport switch.

For example:
 
-listenport 16708


in case you want articy:server to listen on port 16708. Please keep in mind to re-configure your firewall as well, or your client systems won't be able to connect.

Adapter binding


As default the articy:server binds to all adapters on the system. If you want to specify one fixed IPv4 adapter change the value of the -adapter switch.

For example:
 
-adapter 192.168.1.200


in case you want articy:server to only bind to the network adapter with IP 192.168.1.200.

Configure log output directory


By default logs are places into the logs folder of you installation, you may change that behavior by editing the -fld switch to your needs.

For example:
 
-fld C:\MyLogs\


This will put file logs in the directory C:\MyLogs.

Configuring database


By default database related files are places into the db folder of you installation, you may change that behavior by editing the -dbpath switch to your needs.

For example:
 
-dbpath C:\MyDB\


This will put database related files in the directory C:\MyDB.

 
If there is no database file in the given directory, a new database file will be created. If a database file already exists, please put it in the new directory before starting the service.