Toujou

Help: winsrv
Login

Help: winsrv

The "winsrv" command:

Usage: fossil winsrv METHOD ?SERVICE-NAME? ?OPTIONS?

Where METHOD is one of: create delete show start stop.

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

In the following description of the methods, "Fossil-DSCM" will be used as the default SERVICE-NAME:

fossil winsrv create ?SERVICE-NAME? ?OPTIONS?
Creates a service. Available options include:

-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
'fossil 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.

The following options are more or less the same as for the "server" command and influence the behavior of the http 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 ".fossil".
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 "*.fossil" 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

fossil winsrv delete ?SERVICE-NAME?

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

fossil winsrv show ?SERVICE-NAME?

Shows how the service is configured and its current state.

fossil winsrv start ?SERVICE-NAME?

Start the service.

fossil winsrv stop ?SERVICE-NAME?

Stop the service.

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