Fossil SCM
Updates to windows server documenttion to include examples of winsrv command.
Commit
6a0ec82baef5b4d6c2bd6a556bc9124ac18ddfa4d7df173601ce314c64958ace
Parent
10fb90fcae08a31…
3 files changed
+4
-2
+43
-10
+5
-6
+4
-2
| --- www/server/windows/index.md | ||
| +++ www/server/windows/index.md | ||
| @@ -1,6 +1,8 @@ | ||
| 1 | 1 | # Using Windows as a Fossil Server |
| 2 | 2 | |
| 3 | -- [Fossil as a Service](service.md) | |
| 4 | -- [Using stunnel with Fossil on Windows](stunnel.md) | |
| 3 | +- [Fossil server command](./none.md) | |
| 4 | +- [Fossil as CGI (IIS)](./iis.md) | |
| 5 | +- [Fossil as a Service](./service.md) | |
| 6 | +- [Using stunnel with Fossil on Windows](./stunnel.md) | |
| 5 | 7 | |
| 6 | 8 | *[Return to the top-level Fossil server article.](../)* |
| 7 | 9 |
| --- www/server/windows/index.md | |
| +++ www/server/windows/index.md | |
| @@ -1,6 +1,8 @@ | |
| 1 | # Using Windows as a Fossil Server |
| 2 | |
| 3 | - [Fossil as a Service](service.md) |
| 4 | - [Using stunnel with Fossil on Windows](stunnel.md) |
| 5 | |
| 6 | *[Return to the top-level Fossil server article.](../)* |
| 7 |
| --- www/server/windows/index.md | |
| +++ www/server/windows/index.md | |
| @@ -1,6 +1,8 @@ | |
| 1 | # Using Windows as a Fossil Server |
| 2 | |
| 3 | - [Fossil server command](./none.md) |
| 4 | - [Fossil as CGI (IIS)](./iis.md) |
| 5 | - [Fossil as a Service](./service.md) |
| 6 | - [Using stunnel with Fossil on Windows](./stunnel.md) |
| 7 | |
| 8 | *[Return to the top-level Fossil server article.](../)* |
| 9 |
+43
-10
| --- www/server/windows/service.md | ||
| +++ www/server/windows/service.md | ||
| @@ -10,28 +10,61 @@ | ||
| 10 | 10 | |
| 11 | 11 | ## Place Fossil on Server |
| 12 | 12 | |
| 13 | 13 | However you obtained your copy of Fossil, it is recommended that you follow |
| 14 | 14 | Windows conventions and place it within `\Program Files\FossilSCM`. Since |
| 15 | -Fossil 2.10 is a 64bit binary, this is the proper location for the executable. This | |
| 16 | -way Fossil is in an expected location and you will have minimal issues with | |
| 15 | +Fossil 2.10 is a 64bit binary, this is the proper location for the executable. | |
| 16 | +This way Fossil is at an expected location and you will have minimal issues with | |
| 17 | 17 | Windows interfering in your ability to run Fossil as a service. You will need |
| 18 | -Administrative rights to place fossil at the recommended location. You do NOT | |
| 19 | -need to add this location to the path, though you may do so if you wish. | |
| 18 | +Administrative rights to place fossil at the recommended location. If you will | |
| 19 | +only be running Fossil as a service, you do not need to add this location to the | |
| 20 | +path, though you may do so if you wish. | |
| 20 | 21 | |
| 21 | -## Make Fossil a Windows Service | |
| 22 | +## Installing Fossil as a Service | |
| 22 | 23 | |
| 23 | 24 | Luckily the hard work to use Fossil as a Windows Service has been done by the |
| 24 | 25 | Fossil team. We simply have to install it with the proper command line options. |
| 25 | 26 | Fossil on Windows has a command `fossil winsrv` to allow installing Fossil as a |
| 26 | -service on Windows, but the options are limited, so an alternative service | |
| 27 | -install using PowerShell is documented here. The below should all be entered | |
| 28 | -as a single line in an Administrative PowerShell console. | |
| 27 | +service on Windows. This command is only documented on the windows executable | |
| 28 | +of Fossil. You must also run the command as administrator for it to be | |
| 29 | +successful. | |
| 30 | + | |
| 31 | +### Fossil winsrv Example | |
| 32 | + | |
| 33 | +The simplest form of the command is: | |
| 34 | + | |
| 35 | +``` | |
| 36 | +fossil winsrv create --repository D:/Path/to/Repo.fossil | |
| 37 | +``` | |
| 38 | + | |
| 39 | +This will create a windows service named 'Fossil-DSCM' running under the local | |
| 40 | +system account and accessible on port 8080 by default. `fossil winsrv` can also | |
| 41 | +start, stop, and delete the service. For all available options, please execute | |
| 42 | +`fossil help winsrv` on a windows install of Fossil. | |
| 43 | + | |
| 44 | +If you wish to server a directory of repositories, the `fossil winsrv` command | |
| 45 | +requires a slightly different set of options vs. `fossil server`: | |
| 46 | + | |
| 47 | +``` | |
| 48 | +fossil winsrv create --repository D:/Path/to/Repos --repolist | |
| 49 | +``` | |
| 50 | + | |
| 51 | +<a name='PowerShell'></a> | |
| 52 | +### Advanced service installation using PowerShell | |
| 53 | + | |
| 54 | +As great as `fossil winsrv` is, it does not have one to one reflection of all of | |
| 55 | +the `fossil server` [options](/help?cmd=server). When you need to use some of | |
| 56 | +the more advanced options, such as `--https`, `--skin`, or `--extroot`, you will | |
| 57 | +need to use PowerShell to configure and install the Windows service. | |
| 58 | + | |
| 59 | +PowerShell provides the [New-Service](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.management/new-service?view=powershell-5.1) | |
| 60 | +command, which we can use to install and configure Fossil as a service. The | |
| 61 | +below should all be entered as a single line in an Administrative PowerShell | |
| 62 | +console. | |
| 29 | 63 | |
| 30 | 64 | ```PowerShell |
| 31 | -New-Service -Name fossil -DisplayName fossil -BinaryPathName '"C:\Program Files\FossilSCM\fossil.exe" | |
| 32 | -server --port 8080 --repolist "D:/Path/to/Repos"' -StartupType Automatic | |
| 65 | +New-Service -Name fossil -DisplayName fossil -BinaryPathName '"C:\Program Files\FossilSCM\fossil.exe" server --port 8080 --repolist "D:/Path/to/Repos"' -StartupType Automatic | |
| 33 | 66 | ``` |
| 34 | 67 | |
| 35 | 68 | Please note the use of forward slashes in the repolist path passed to Fossil. |
| 36 | 69 | Windows will accept either back slashes or forward slashes in path names, but |
| 37 | 70 | Fossil has a preference for forward slashes. The use of `--repolist` will make |
| 38 | 71 |
| --- www/server/windows/service.md | |
| +++ www/server/windows/service.md | |
| @@ -10,28 +10,61 @@ | |
| 10 | |
| 11 | ## Place Fossil on Server |
| 12 | |
| 13 | However you obtained your copy of Fossil, it is recommended that you follow |
| 14 | Windows conventions and place it within `\Program Files\FossilSCM`. Since |
| 15 | Fossil 2.10 is a 64bit binary, this is the proper location for the executable. This |
| 16 | way Fossil is in an expected location and you will have minimal issues with |
| 17 | Windows interfering in your ability to run Fossil as a service. You will need |
| 18 | Administrative rights to place fossil at the recommended location. You do NOT |
| 19 | need to add this location to the path, though you may do so if you wish. |
| 20 | |
| 21 | ## Make Fossil a Windows Service |
| 22 | |
| 23 | Luckily the hard work to use Fossil as a Windows Service has been done by the |
| 24 | Fossil team. We simply have to install it with the proper command line options. |
| 25 | Fossil on Windows has a command `fossil winsrv` to allow installing Fossil as a |
| 26 | service on Windows, but the options are limited, so an alternative service |
| 27 | install using PowerShell is documented here. The below should all be entered |
| 28 | as a single line in an Administrative PowerShell console. |
| 29 | |
| 30 | ```PowerShell |
| 31 | New-Service -Name fossil -DisplayName fossil -BinaryPathName '"C:\Program Files\FossilSCM\fossil.exe" |
| 32 | server --port 8080 --repolist "D:/Path/to/Repos"' -StartupType Automatic |
| 33 | ``` |
| 34 | |
| 35 | Please note the use of forward slashes in the repolist path passed to Fossil. |
| 36 | Windows will accept either back slashes or forward slashes in path names, but |
| 37 | Fossil has a preference for forward slashes. The use of `--repolist` will make |
| 38 |
| --- www/server/windows/service.md | |
| +++ www/server/windows/service.md | |
| @@ -10,28 +10,61 @@ | |
| 10 | |
| 11 | ## Place Fossil on Server |
| 12 | |
| 13 | However you obtained your copy of Fossil, it is recommended that you follow |
| 14 | Windows conventions and place it within `\Program Files\FossilSCM`. Since |
| 15 | Fossil 2.10 is a 64bit binary, this is the proper location for the executable. |
| 16 | This way Fossil is at an expected location and you will have minimal issues with |
| 17 | Windows interfering in your ability to run Fossil as a service. You will need |
| 18 | Administrative rights to place fossil at the recommended location. If you will |
| 19 | only be running Fossil as a service, you do not need to add this location to the |
| 20 | path, though you may do so if you wish. |
| 21 | |
| 22 | ## Installing Fossil as a Service |
| 23 | |
| 24 | Luckily the hard work to use Fossil as a Windows Service has been done by the |
| 25 | Fossil team. We simply have to install it with the proper command line options. |
| 26 | Fossil on Windows has a command `fossil winsrv` to allow installing Fossil as a |
| 27 | service on Windows. This command is only documented on the windows executable |
| 28 | of Fossil. You must also run the command as administrator for it to be |
| 29 | successful. |
| 30 | |
| 31 | ### Fossil winsrv Example |
| 32 | |
| 33 | The simplest form of the command is: |
| 34 | |
| 35 | ``` |
| 36 | fossil winsrv create --repository D:/Path/to/Repo.fossil |
| 37 | ``` |
| 38 | |
| 39 | This will create a windows service named 'Fossil-DSCM' running under the local |
| 40 | system account and accessible on port 8080 by default. `fossil winsrv` can also |
| 41 | start, stop, and delete the service. For all available options, please execute |
| 42 | `fossil help winsrv` on a windows install of Fossil. |
| 43 | |
| 44 | If you wish to server a directory of repositories, the `fossil winsrv` command |
| 45 | requires a slightly different set of options vs. `fossil server`: |
| 46 | |
| 47 | ``` |
| 48 | fossil winsrv create --repository D:/Path/to/Repos --repolist |
| 49 | ``` |
| 50 | |
| 51 | <a name='PowerShell'></a> |
| 52 | ### Advanced service installation using PowerShell |
| 53 | |
| 54 | As great as `fossil winsrv` is, it does not have one to one reflection of all of |
| 55 | the `fossil server` [options](/help?cmd=server). When you need to use some of |
| 56 | the more advanced options, such as `--https`, `--skin`, or `--extroot`, you will |
| 57 | need to use PowerShell to configure and install the Windows service. |
| 58 | |
| 59 | PowerShell provides the [New-Service](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.management/new-service?view=powershell-5.1) |
| 60 | command, which we can use to install and configure Fossil as a service. The |
| 61 | below should all be entered as a single line in an Administrative PowerShell |
| 62 | console. |
| 63 | |
| 64 | ```PowerShell |
| 65 | New-Service -Name fossil -DisplayName fossil -BinaryPathName '"C:\Program Files\FossilSCM\fossil.exe" server --port 8080 --repolist "D:/Path/to/Repos"' -StartupType Automatic |
| 66 | ``` |
| 67 | |
| 68 | Please note the use of forward slashes in the repolist path passed to Fossil. |
| 69 | Windows will accept either back slashes or forward slashes in path names, but |
| 70 | Fossil has a preference for forward slashes. The use of `--repolist` will make |
| 71 |
+5
-6
| --- www/server/windows/stunnel.md | ||
| +++ www/server/windows/stunnel.md | ||
| @@ -19,18 +19,17 @@ | ||
| 19 | 19 | URLs when used with stunnel as a proxy. Please make sure you are using Fossil |
| 20 | 20 | 2.10 or later on Windows. |
| 21 | 21 | |
| 22 | 22 | ## Configure Fossil Service for https |
| 23 | 23 | |
| 24 | -Following most of [Fossil as a Windows Service](./service.md), you will need | |
| 25 | -to change the command to install the Fossil Service to configure it properly for | |
| 26 | -use with stunnel as an https proxy. Run the following instead: | |
| 24 | +Due to the need for the `--https` option for successfully using Fossil with | |
| 25 | +stunnel, we will use [Advanced service installation using PowerShell](./service.md#PowerShell). | |
| 26 | +We will need to change the command to install the Fossil Service to configure | |
| 27 | +it properly for use with stunnel as an https proxy. Run the following: | |
| 27 | 28 | |
| 28 | 29 | ```PowerShell |
| 29 | -New-Service -Name fossil-secure -DisplayName fossil-secure -BinaryPathName '"C:\Program Files\FossilSCM\fossil.exe" | |
| 30 | -server --localhost --port 9000 --https --repolist "D:/Path/to/Repos"' -StartupType Automatic | |
| 31 | - | |
| 30 | +New-Service -Name fossil-secure -DisplayName fossil-secure -BinaryPathName '"C:\Program Files\FossilSCM\fossil.exe" server --localhost --port 9000 --https --repolist "D:/Path/to/Repos"' -StartupType Automatic | |
| 32 | 31 | ``` |
| 33 | 32 | |
| 34 | 33 | The use of `--localhost` means Fossil will only listen for traffic on the local |
| 35 | 34 | host on the designated port - 9000 in this case - and will not respond to |
| 36 | 35 | network traffic. Using `--https` will tell Fossil to generate HTTPS URLs rather |
| 37 | 36 |
| --- www/server/windows/stunnel.md | |
| +++ www/server/windows/stunnel.md | |
| @@ -19,18 +19,17 @@ | |
| 19 | URLs when used with stunnel as a proxy. Please make sure you are using Fossil |
| 20 | 2.10 or later on Windows. |
| 21 | |
| 22 | ## Configure Fossil Service for https |
| 23 | |
| 24 | Following most of [Fossil as a Windows Service](./service.md), you will need |
| 25 | to change the command to install the Fossil Service to configure it properly for |
| 26 | use with stunnel as an https proxy. Run the following instead: |
| 27 | |
| 28 | ```PowerShell |
| 29 | New-Service -Name fossil-secure -DisplayName fossil-secure -BinaryPathName '"C:\Program Files\FossilSCM\fossil.exe" |
| 30 | server --localhost --port 9000 --https --repolist "D:/Path/to/Repos"' -StartupType Automatic |
| 31 | |
| 32 | ``` |
| 33 | |
| 34 | The use of `--localhost` means Fossil will only listen for traffic on the local |
| 35 | host on the designated port - 9000 in this case - and will not respond to |
| 36 | network traffic. Using `--https` will tell Fossil to generate HTTPS URLs rather |
| 37 |
| --- www/server/windows/stunnel.md | |
| +++ www/server/windows/stunnel.md | |
| @@ -19,18 +19,17 @@ | |
| 19 | URLs when used with stunnel as a proxy. Please make sure you are using Fossil |
| 20 | 2.10 or later on Windows. |
| 21 | |
| 22 | ## Configure Fossil Service for https |
| 23 | |
| 24 | Due to the need for the `--https` option for successfully using Fossil with |
| 25 | stunnel, we will use [Advanced service installation using PowerShell](./service.md#PowerShell). |
| 26 | We will need to change the command to install the Fossil Service to configure |
| 27 | it properly for use with stunnel as an https proxy. Run the following: |
| 28 | |
| 29 | ```PowerShell |
| 30 | New-Service -Name fossil-secure -DisplayName fossil-secure -BinaryPathName '"C:\Program Files\FossilSCM\fossil.exe" server --localhost --port 9000 --https --repolist "D:/Path/to/Repos"' -StartupType Automatic |
| 31 | ``` |
| 32 | |
| 33 | The use of `--localhost` means Fossil will only listen for traffic on the local |
| 34 | host on the designated port - 9000 in this case - and will not respond to |
| 35 | network traffic. Using `--https` will tell Fossil to generate HTTPS URLs rather |
| 36 |