Skip to content

Commit

Permalink
The octo.exe page redirects to octopus-cli.
Browse files Browse the repository at this point in the history
  • Loading branch information
steve-fenton-octopus committed Jan 7, 2025
1 parent 2fd2099 commit 57cd6d9
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 36 deletions.
4 changes: 4 additions & 0 deletions dictionary-octopus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ advfirewall
ALLUSERSPROFILE
anglin
Anglin
Antiforgery
apikey
apikeys
APPNAME
Expand Down Expand Up @@ -90,10 +91,12 @@ DESTKEY
DIND
Directorygroup
Distro
distros
Dockerfiles
dockerhub
Domainname
DONTVALIDATEPATH
DPAPI
dpkg
dryrun
Dspring
Expand Down Expand Up @@ -392,6 +395,7 @@ SSPI
SSRS
statefulset
statefulsets
stepsprodpackages
sthumb
strconv
struct
Expand Down
9 changes: 4 additions & 5 deletions src/pages/docs/deployments/dotnet/netcore-webapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ASP.NET Core is fast becoming the de-facto web framework in .NET. Compared to ea

If you are new to ASP.NET Core you can start with the [Tutorial: Get Started ASP.Net Core tutorial](https://docs.microsoft.com/en-us/aspnet/core/getting-started/?view=aspnetcore-5.0).

## Publishing and packing the website {#DeployingASP.NETCoreWebApplications-PublishingandPackingtheWebsite}
## Publishing and packing the website {#publishing-and-packing-the-website}

When your application is ready, it needs to be published:

Expand All @@ -29,7 +29,7 @@ octo pack --id MyApp.Web --version 1.0.0 --basePath published-app

For more information about packaging applications see [Creating packages using the Octopus CLI](/docs/packaging-applications/create-packages/octopus-cli).

If you are using the [built-in repository](/docs/packaging-applications/package-repositories/built-in-repository/#pushing-packages-to-the-built-in-repository) you can create a [zip file](/docs/packaging-applications/create-packages/octopus-cli/#create-zip-packages).
If you are using the [built-in repository](/docs/packaging-applications/package-repositories/built-in-repository/#pushing-packages-to-the-built-in-repository) you can create a [zip file](/docs/packaging-applications/create-packages/octopus-cli#create-zip-packages).

When you have your generated nupkg or zip file it needs to be [pushed to a repository](/docs/packaging-applications/package-repositories).

Expand All @@ -54,7 +54,7 @@ When running under IIS, ensure the .NET CLR Version is set to `No Managed Code`.

The `.AspNetCore.Antiforgery` cookie created by ASP.NET Core uses the application path to generate its hash. By default Octopus will deploy to a new path every time, which causes a new cookie to be set every deploy. This results in many unneeded cookies in the browser. See this [blog post](http://blog.novanet.no/a-pile-of-anti-forgery-cookies/) for more details. To change this behavior, set the Antiforgery token in your `startup.cs` like this:

```
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddAntiforgery(opts => opts.CookieName = "AntiForgery.MyAppName");
Expand All @@ -65,7 +65,7 @@ public void ConfigureServices(IServiceCollection services)

Similar to antiforgery cookies, cookie authentication in ASP.NET Core 2 uses Microsoft's data protection API (DPAPI) which can use the application path to isolates applications from one another. This can cause older cookies to simply not work. To change this behavior, you need to set the application name in your `startup.cs` like this:

```
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddDataProtection().SetApplicationName("my application");
Expand All @@ -76,7 +76,6 @@ public void ConfigureServices(IServiceCollection services)

Refer to [structured configuration variables](/docs/projects/steps/configuration-features/structured-configuration-variables-feature) on how to setup configuration.


## Learn more

- Generate an Octopus guide for [ASP.NET Core and the rest of your CI/CD pipeline](https://octopus.com/docs/guides?application=ASP.NET%20Core).
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ navOrder: 1

The sample project for this guide is the [Angular project template with ASP.NET Core](https://docs.microsoft.com/en-us/aspnet/core/client-side/spa/angular?view=aspnetcore-2.1) application. The template consists of an ASP.NET Core project to act as an API backend and an Angular CLI project to act as a UI. The base project has been modified slightly to host the Angular CLI project outside of the ASP.NET Core project to enable us to configure NGINX both as a reverse proxy to the ASP.NET Core project while also serving the Angular CLI project as static content from the file system.

## Upload the package to the built-in repository {#Create&PushASP.NETCoreProject-Uploadthepackagetothebuilt-inrepository}
## Upload the package to the built-in repository

Firstly we need to make the package available for Octopus to deploy.

:::div{.success}
We've crafted and packaged v1.0.0 of this sample application for you to try out (see the link below). Alternatively you can create your own application and [package the application](/docs/packaging-applications) yourself to try it out. Click [here](#Create&PushASP.NETCoreProject-PublishingandPackingtheWebsite) for steps to publish and package the ASP.NET Core project.
We've crafted and packaged v1.0.0 of this sample application for you to try out (see the link below). Alternatively you can create your own application and [package the application](/docs/packaging-applications) yourself to try it out. Click [here](#publishing-and-packing-the-website) for steps to publish and package the ASP.NET Core project.
:::

1. Download [NginxSampleWebApp.1.0.0.zip](/docs/attachments/nginxsamplewebapp.1.0.0.zip).
2. [Upload it to the Octopus Built-In repository](/docs/packaging-applications/package-repositories/built-in-repository/#pushing-packages-to-the-built-in-repository) (you can do this by going to **Library ➜ Packages** and clicking the **Upload package** button).

## Publishing and packing the website {#Create&PushASP.NETCoreProject-PublishingandPackingtheWebsite}
## Publishing and packing the website {#publishing-and-packing-the-website}

```powershell
# Publish the application to a folder
Expand All @@ -31,7 +31,7 @@ octo pack --id NginxSampleWebApp --version 1.0.0 --basePath published-app
```

:::div{.hint}
If you are using the built-in repository, you can create a [zip file](/docs/packaging-applications/create-packages/octopus-cli/#create-zip-packages) instead. The generated nupkg or zip file should then be then be [pushed to a repository](/docs/packaging-applications/package-repositories).
If you are using the built-in repository, you can create a [zip file](/docs/packaging-applications/create-packages/octopus-cli#create-zip-packages) instead. The generated nupkg or zip file should then be then be [pushed to a repository](/docs/packaging-applications/package-repositories).
:::

## Learn more
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,18 @@ If you are writing a cross-platform script, be aware of the differences between
:::div{.hint}
**Bash (and other shell) variables**
Octopus Deploy will log into the SSH target via a non-interactive shell. Because of this, startup files like `.bashrc` are not fully evaluated. If you are referencing bash variables `export`ed in these files, you should move them before the following common code block at the top of the file:
```

```bash
# If not running interactively, don't do anything
case $- in
*i*) ;;
*) return;;
esac
```

This will ensure that they are evaluated on non-interactive logins.
:::


### Example: Using variables in Bash

Your script can use a [variable value](/docs/projects/variables) by invoking the `get_octopusvariable` function. For example, to echo out the installation directory call
Expand All @@ -48,25 +49,25 @@ Your script can use a [variable value](/docs/projects/variables) by invoking the
You can also set an [output variable](/docs/projects/variables/output-variables):

> ```
> set_octopusvariable RandomNumber 3
> ```
```bash
set_octopusvariable RandomNumber 3
```

### Example: Collecting an artifact

Your script can tell Octopus to collect a file and store it as a [deployment artifact](/docs/projects/deployment-process/artifacts):

> ```
> new_octopusartifact "./subdir/anotherdir/myfile"
> ```
```bash
new_octopusartifact "./subdir/another_dir/myfile"
```

which results in the server retrieving that file, at the end of that step. Keep in mind that this means the file must be accessible over SFTP using the same credentials as that used during execution.

## Transport

The package and any supporting deployment files are uploaded via SFTP.

## File footprint {#SSHTargets-Footprint}
## File footprint

- The root directory for all Octopus work is `$HOME/.octopus`
- All packages are deployed to a relative location at `$HOME/.octopus/Applications/#{instance}/#{environment}/#{package}/#{version}`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ dotnet publish ./OctoWeb.csproj --output ./dist
dotnet octo pack ./dist --id="OctoWeb" --version="1.0.0"
```

Please refer to [Microsoft's publish and packing](/docs/deployments/dotnet/netcore-webapp/#DeployingASP.NETCoreWebApplications-PublishingandPackingtheWebsite) documentation for more information.
Please refer to [Microsoft's publish and packing](/docs/deployments/dotnet/netcore-webapp/#publishing-and-packing-the-website) documentation for more information.

## Packaging a .NET Core library

Expand Down
33 changes: 17 additions & 16 deletions src/pages/docs/security/outbound-requests/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ navOrder: 25

This page describes any outbound network requests made by Octopus and Tentacle, and what information is included when Octopus checks for updates.

## Outbound requests by Tentacle {#Outboundrequests-OutboundrequestsbyTentacle}
## Outbound requests by Tentacle

For security reasons, we minimize the number of outbound requests made by the Tentacle deployment agent. The only outbound requests you should see are for:

Expand All @@ -20,7 +20,7 @@ For security reasons, we minimize the number of outbound requests made by the Te

It's possible that scripts in your packages may make outbound requests; in this case you should take care when deploying packages created by a third party.

## Outbound requests by Octopus {#Outboundrequests-OutboundrequestsbyOctopus}
## Outbound requests by Octopus

The Octopus Server makes the following outbound requests:

Expand All @@ -30,7 +30,7 @@ The Octopus Server makes the following outbound requests:
4. Checking for updates (if enabled).
5. Checking for updated [built-in step templates](/docs/projects/built-in-step-templates) (if enabled).
6. Checking for updated [community contributed step templates](/docs/projects/community-step-templates) (if enabled).
7. Behavioral telemetry is sent to https://telemetry.octopus.com (if enabled).
7. Behavioral telemetry is sent to `https://telemetry.octopus.com` (if enabled).

### Built-in step templates

Expand All @@ -43,7 +43,7 @@ From **Octopus 2022.1** some built-in step templates can be automatically update

Our community contributed step template integration queries `library.octopus.com` for updates.

## What information is included when Octopus checks for updates? {#Outboundrequests-WhatinformationisincludedwhenOctopuschecksforupdates?}
## What information is included when Octopus checks for updates?

By default, Octopus will periodically check for new releases. You can opt-out of checking for updates by navigating to **Configuration ➜ Settings ➜ Updates** in Octopus.

Expand All @@ -60,15 +60,16 @@ The Octopus.com site is hosted on Microsoft Azure, so you will see traffic going
## Disabling outbound requests

In isolated/air-gapped scenarios without access to the internet, it may prove beneficial to disable attempts to contact these external services to prevent failed tasks and/or errors in the logs. Details on how to disable each feature are as follows:
* Octopus Server updates
* Via the Web Portal: **Configuration ➜ Settings ➜ Updates**
* Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --upgradeCheck=false`
* Built-in step template updates
* Via the Web Portal: **Configuration ➜ Features ➜ Step Template Updates**
* Community step updates
* Via the Web Portal: **Configuration ➜ Features ➜ Community Step Templates**
* Telemetry
* Via the Web Portal: **Configuration ➜ Telemetry**
* Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --sendTelemetry=false`
* Dynamic Extensions
* Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --dynamicExtensionsEnabled=false`

- Octopus Server updates
- Via the Web Portal: **Configuration ➜ Settings ➜ Updates**
- Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --upgradeCheck=false`
- Built-in step template updates
- Via the Web Portal: **Configuration ➜ Features ➜ Step Template Updates**
- Community step updates
- Via the Web Portal: **Configuration ➜ Features ➜ Community Step Templates**
- Telemetry
- Via the Web Portal: **Configuration ➜ Telemetry**
- Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --sendTelemetry=false`
- Dynamic Extensions
- Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --dynamicExtensionsEnabled=false`
1 change: 0 additions & 1 deletion tests/bookmark.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ const bookmarks = [
'/docs/packaging-applications#version-numbers',
'/docs/packaging-applications/create-packages/octopus-cli#create-zip-packages',
'/docs/packaging-applications/create-packages/octopus-cli#packaging-a-net-core-application',
'/docs/packaging-applications/octo.exe#create-zip-packages',
'/docs/packaging-applications/package-repositories/built-in-repository#built-in-repository-reindexing',
'/docs/projects/coordinating-multiple-projects/deploy-release-step#variables',
'/docs/projects/export-import#packages',
Expand Down

0 comments on commit 57cd6d9

Please sign in to comment.