winsrv¶

vb winsrv SUBCOMMAND [SERVICE-NAME] [OPTIONS]

Description¶

The winsrv command manages VisionByte as a Windows service. This allows (for example) VisionByte to be running in the background when no user is logged in.

In the following description of the methods, VisionByte-DSCM will be used as the default SERVICE-NAME.

NOTE: This command is available on Windows operating systems only and requires administrative rights on the machine executed.

Subcommands¶

vb winsrv create¶

vb winsrv create [SERVICE-NAME] [OPTIONS]

Description¶

Creates a service. Available options include:

Options¶

-D, --display DISPLAY-NAME¶: Sets the display name of the service. This name is shown by graphical interface programs. By default, the display name is equal to the service name.

-S, --start TYPE¶: Sets the start type of the service. TYPE can be manual, which means you need to start the service yourself with the vb winsrv start command or with the net start command from the operating system. If TYPE is set to auto, the service will be started automatically by the system during startup.

--username USERNAME¶: Specifies the user account which will be used to run the service. The account needs the Logon as a service right enabled in its profile. Specify local accounts as follows: .\\USERNAME. By default, the LocalSystem account will be used.

-W, --password PASSWORD¶: Password for the user account.

Server options¶

The following options are about for the server.

--baseurl URL¶: Use URL as the base (useful for reverse proxies)

-P, --port TCPPORT¶: Specifies the TCP port (default port is 8080) on which the server should listen.

-R, --repository REPO¶: Specifies the name of the repository to be served. The repository option may be omitted if the working directory is within an open check-out. The REPOSITORY can be a directory (aka folder) that contains one or more repositories with names ending in .vbyte. In that case, the first element of the URL is used to select among the various repositories.

--notfound URL¶: If REPOSITORY is a directory that contains one or more repositories with names of the form \*.vbyte then the first element of the URL pathname selects among the various repositories. If the pathname does not select a valid repository and the –notfound option is available, then the server redirects (HTTP code 302) to the URL of –notfound.

--localauth¶: Enables automatic login if the –localauth option is present and the localauth setting is off and the connection is from localhost.

--repolist¶: If REPOSITORY is directory, URL / lists all repositories.

--scgi¶: Create an SCGI server instead of an HTTP server

vb winsrv delete¶

vb winsrv delete [SERVICE-NAME]

Description¶

Deletes a service. If the service is currently running, it will be stopped first and then deleted.

vb winsrv show¶

vb winsrv show [SERVICE-NAME]

Description¶

Shows how the service is configured and its current state.

vb winsrv start¶

vb winsrv start [SERVICE-NAME]

Description¶

Start the service.

vb winsrv stop¶

vb winsrv stop [SERVICE-NAME]

Description¶

Stop the service.

Examples¶

Create a default server

$ vb winsrv create
Service 'VisionByte-Web-DSCM' successfully created.

Start the default server

$ vb winsrv start
Starting service 'VisionByte-Web-DSCM'.
Service 'VisionByte-Web-DSCM' started.

Shows how the service is configured and its current state

$ vb winsrv show
Service name .......: VisionByte-Web-DSCM
Display name .......: VisionByte-Web-DSCM
Service description : VisionByte - Simple, Fast, Streaming VCS
Service type .......: Service runs in its own process.
Service start type .: Started manually.
Binary path name ...: "C:\Users\FrankLi\Desktop\exe\vb.exe" server "C:/Users/FrankLi/Desktop/TestA/testa.vbyte"
Service username ...: LocalSystem
Current state ......: Running.

Stop the default server

$ vb winsrv stop
Stopping service 'VisionByte-Web-DSCM'
Service 'VisionByte-Web-DSCM' stopped.

Delete the default server

$ vb winsrv delete
Service 'VisionByte-Web-DSCM' successfully deleted.