Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2023-01-01
modDate: 2026-10-27
title: Script Console
description: The Script Console allows Octopus administrators to execute scripts and perform administrative tasks on workers and deployment targets as groups or individuals.
navOrder: 600
Expand All @@ -21,10 +21,10 @@ Any machines registered with Octopus as [workers](/docs/infrastructure/workers/)

## Use the Script Console

The Script Console can be found under the Tasks area:
The Script Console runs scripts within a space, so it's only available from a space's Tasks page, not the global Tasks page. To open it, navigate to **Deploy ➜ Tasks** in the space you want to work in, and click **Script console**:

:::figure
![The Script Console button in the Tasks area](/docs/img/administration/managing-infrastructure/images/tasks-script-console-button.png)
![The Script Console button on the space-level Tasks page](/docs/img/administration/managing-infrastructure/images/tasks-script-console-button.png)
:::

Inside the Script Console, you can choose whether to run your script on:
Expand Down Expand Up @@ -92,3 +92,7 @@ Sometimes you might like to collect files from each of the machines as part of y
Besides making it easy to run a script on many servers, the other advantage of using the Script Console is auditing. Ad-hoc scripts run via the Script Console will appear in the [Audit](/docs/security/users-and-teams/auditing) tab in the Configuration area.

![A Script Console run recorded in the audit log](/docs/img/administration/managing-infrastructure/images/script-console-audit.png)

## Version notes

- The **Script console** button moved from the global Tasks page to the space-level Tasks page (**Deploy ➜ Tasks**) in Octopus Server 2027.0. In earlier versions, it's on the global Tasks page.
2 changes: 1 addition & 1 deletion src/pages/docs/projects/custom-step-templates/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ If the linking process isn't linking a template that you believe should be linke

## Running script based custom step templates

You can run script based custom step templates on a group of machines. This can be very handy to execute script based step templates to test them before starting to use them in your projects as well as performing regular admin or operations functions. This should be familiar to people who have used the [script console](/docs/administration/managing-infrastructure/performance/enable-web-request-logging) in the past.
You can run script based custom step templates on a group of machines. This can be very handy to execute script based step templates to test them before starting to use them in your projects as well as performing regular admin or operations functions. This should be familiar to people who have used the [script console](/docs/administration/managing-infrastructure/script-console) in the past.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drive-by fix for link url


:::div{.hint}
It's important to note that you can only run script based custom step templates. It's not currently possible to execute step templates based on other step types.
Expand Down
Loading