Skip to content

Commit

Permalink
Updating ScriptCS references
Browse files Browse the repository at this point in the history
  • Loading branch information
IsaacCalligeros95 committed Oct 11, 2023
1 parent 270efe1 commit 65b9604
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 19 deletions.
4 changes: 2 additions & 2 deletions src/pages/docs/deployments/custom-scripts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2023-01-01
title: Custom scripts
description: Custom scripts allows you to script anything you want using PowerShell, ScriptCS, F#, Python, or Bash.
description: Custom scripts allows you to script anything you want using PowerShell, Dotnet Script, F#, Python, or Bash.
navOrder: 120
---

Expand All @@ -16,7 +16,7 @@ Octopus supports the following scripting environments:
- PowerShell scripts (.ps1)
- Bash scripts (.sh)
- Python scripts (.py)
- C# scripts (.csx) using [ScriptCS](https://github.com/scriptcs/scriptcs)
- C# scripts (.csx) using [dotnet-script](https://github.com/dotnet-script/dotnet-script)
- F# scripts (.fsx)

Octopus can run these scripts on almost any operating system as long as the script runtime is installed and configured correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,12 @@ Octopus can execute Python scripts on SSH targets provided the following criteri
- Python3 is on the path for the SSH user executing the deployment
- pip is installed or the pycryptodome python package is installed

## ScriptCS and F#
## F#

Support for ScriptCS and F# scripts are only available with **Mono 4** and above. While they require mono installed, they will still execute with the self-contained Calamari.

ScriptCS has not been ported for .NET Core ([GitHub issue](https://github.com/scriptcs/scriptcs/issues/1183)).
Support F# scripts is only available with **Mono 4** and above. While they require mono installed, they will still execute with the self-contained Calamari.

Similarly, the F# interpreter has also not yet been ported for .NET Core ([GitHub issue](https://github.com/Microsoft/visualfsharp/issues/2407)).

:::div{.warning}

ScriptCS does not work on Mono **5.16** and higher. We recommend using Mono **5.14.x**.
:::

## Self-contained Calamari {#self-contained-calamari}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,10 @@ Linux Tentacle is a .NET application distributed as a [self-contained deployment

## Known limitations

Support for ScriptCS and F# scripts are only available with **Mono 4** and above. While they require mono installed, they will still execute with the self-contained Calamari.

ScriptCS has not been ported for .NET Core ([GitHub issue](https://github.com/scriptcs/scriptcs/issues/1183)).
Support for F# scripts is only available with **Mono 4** and above. While it requires mono installed, it will still execute with the self-contained Calamari.

Similarly, the F# interpreter has also not yet been ported for .NET Core ([GitHub issue](https://github.com/Microsoft/visualfsharp/issues/2407)).

:::div{.warning}
ScriptCS does not work on Mono **5.16** and higher. We recommend using Mono **5.14.x**.
:::

## Downloads

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This guide is designed to address the differences between the Windows and Linux

- **Folder Paths:** Windows Containers follow the Windows folder structure with `\` slashes, for example, `C:\Octopus\Tasklogs`. Linux Containers follow a Linux folder structure, including `/` slashes.
- **Pre-installed software:** Windows Containers include PowerShell and .NET 4.7.2 (or 4.8) but not Bash. Linux Containers typically include PowerShell Core and Bash but not .NET.
- **Software support:** The Linux Container doesn't support running ScriptCS or F# scripts directly on the server.
- **Software support:** The Linux Container doesn't support running F# scripts directly on the server.
- **Authentication:** The Octopus Server Linux Container doesn't support Active Directory authentication. Some users have had success using Active Directory with the Octopus Server Windows Container, but any workarounds won't work with the Linux Container. If you want to use Active Directory, you must connect to it via the [LDAP authentication provider](/docs/security/authentication/ldap).

:::div{.hint}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The differences between running Octopus Server on Windows Server and Linux Conta

- **Folder Paths:** Windows uses a folder structure with `\` slashes, for example, `C:\Octopus\Tasklogs`. Linux Containers follow a Linux folder structure, including `/` slashes.
- **Pre-installed software:** Linux Containers typically include PowerShell Core and Bash but not .NET. You cannot pre-install any other software on the Octopus Linux Container.
- **Software support:** The Linux Container doesn't support running ScriptCS or F# scripts directly on the server.
- **Software support:** The Linux Container doesn't support running F# scripts directly on the server.
- **Authentication:** The Octopus Server Linux Container doesn't support Active Directory authentication. If you want to use Active Directory, you must connect to it via the [LDAP authentication provider](/docs/security/authentication/ldap).

:::div{.hint}
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/octopus-rest-api/calamari.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Calamari deploy-package --package MyPackage.nupkg --variables Variables.json
Calamari has commands to support:

- Deploying NuGet packages.
- Running scripts (PowerShell, ScriptCS, Bash, F#).
- Running scripts (PowerShell, Dotnet Script, Bash, F#).
- Deploying packages to Azure targets (Cloud Services, WebApps).
- Various other deployment related activities.

Expand Down

0 comments on commit 65b9604

Please sign in to comment.