You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/integrating/hooks.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
Hooks allow your application to run logic at various stages of the install/update/uninstall process.
5
5
6
-
In general, I don't recommend trying to handle hooks manually - and instead refer to the available [VelopackApp](../reference/cs/Velopack/VelopackApp.md) options.
6
+
In general, I don't recommend trying to handle hooks manually - and instead refer to the available [VelopackApp](../reference/cs/Velopack/VelopackApp) options.
7
7
8
8
If you wish to handle these yourself, an SDK doesn't exist for your language, or you just want to learn more about it, read on.
The full list of options [for VelopackApp is available here](../reference/cs//Velopack/VelopackApp.md). You can also read more about [how hooks work](./hooks.mdx).
43
+
The full list of options [for VelopackApp is available here](../reference/cs/Velopack/VelopackApp). You can also read more about [how hooks work](./hooks.mdx).
44
44
45
45
:::warning
46
46
A "FastCallback" requires that your application show no UI and exit quickly. When the callback returns, your application will exit. If you do not exit this callback quickly enough your process will be killed.
47
47
:::
48
48
49
49
## Configuring Updates
50
-
Updates can be accomplished by adding [UpdateManager](../reference/cs/Velopack/UpdateManager.md) to your app:
50
+
Updates can be accomplished by adding [UpdateManager](../reference/cs/Velopack/UpdateManager) to your app:
51
51
52
52
```cs
53
53
privatestaticasyncTaskUpdateMyApp()
@@ -76,12 +76,12 @@ You can host your update packages basically anywhere, here are a few examples:
76
76
- HTTP server, or S3, Azure Storage, etc:<br/>`new UpdateManager("https://the.place/you-host/updates")`
There are a variety of built-in sources (eg. [GithubSource](../reference/cs/Velopack.Sources/GithubSource.md), [SimpleWebSource](../reference/cs/Velopack.Sources/SimpleWebSource.md)) you can use when checking for updates, but you can also build your own by [deriving from IUpdateSource](../reference/cs/Velopack.Sources/IUpdateSource.md).
79
+
There are a variety of built-in sources (eg. [GithubSource](../reference/cs/Velopack/Sources/GithubSource), [SimpleWebSource](../reference/cs/Velopack/Sources/SimpleWebSource)) you can use when checking for updates, but you can also build your own by [deriving from IUpdateSource](../reference/cs/Velopack/Sources/IUpdateSource).
80
80
81
81
### Check for updates
82
-
`CheckForUpdatesAsync` will read the provided update source for a `releases.{channel}.json` file to retrieve available updates ([Read about channels](../packaging/channels.mdx)). If there is an update available, a non-null [UpdateInfo](../reference/cs/Velopack/UpdateInfo.md) will be returned with some details about the update. You can also [retrieve any release notes](release-notes.mdx) which were provided when the update was packaged.
82
+
`CheckForUpdatesAsync` will read the provided update source for a `releases.{channel}.json` file to retrieve available updates ([Read about channels](../packaging/channels.mdx)). If there is an update available, a non-null [UpdateInfo](../reference/cs/Velopack/UpdateInfo) will be returned with some details about the update. You can also [retrieve any release notes](release-notes.mdx) which were provided when the update was packaged.
83
83
84
-
There are [also some options](../reference/cs/Velopack/UpdateOptions.md) which can be passed in to [UpdateManager](../reference/cs/Velopack/UpdateManager.md) to customise how updates are handled, eg. to allow things like [switching channels](switching-channels.mdx).
84
+
There are [also some options](../reference/cs/Velopack/UpdateOptions) which can be passed in to [UpdateManager](../reference/cs/Velopack/UpdateManager) to customise how updates are handled, eg. to allow things like [switching channels](switching-channels.mdx).
85
85
86
86
### Download updates
87
87
`DownloadUpdatesAsync` will attempt to download deltas (if available) and re-construct the latest full release. If there are no deltas available, or the delta reconstruction fails, the latest full release package will be downloaded instead. Note that if an option like `AllowVersionDowngrade` is specified, the downloaded version might be older than the currently executing version.
Copy file name to clipboardexpand all lines: docs/troubleshooting/debugging.mdx
+2-1
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,8 @@ new UpdateManager("https://path.to/your-updates", logger: new ConsoleLogger());
29
29
## Logging in the Velopack binaries
30
30
31
31
### Windows
32
-
Running Update.exe will log most output to it's base directory as `Velopack.log`. Setup.exe will not log to file by default. However, you can override the log location for both binaries with the `--log {path}` parameter. You can also use the `--verbose` flag to capture debug/trace output to log. Unfortunately, on Windows, to avoid showing up as a console window, these binaries are compiled as a WinExe and there will be no console output by default. Please see the [command line reference](cli.mdx) for a comprehensive list of arguments supported.
32
+
Running Update.exe will log most output to it's base directory as `Velopack.log`. Setup.exe will not log to file by default. However, you can override the log location for both binaries with the `--log {path}` parameter. You can also use the `--verbose` flag to capture debug/trace output to log. Unfortunately, on Windows, to avoid showing up as a console window, these binaries are compiled as a WinExe and there will be no console output by default.
33
+
Please see the [command line reference](../reference/cli) for a comprehensive list of arguments supported.
0 commit comments