octopusdeploy / docs Goto Github PK

When limiting permissions for the user that the service runs under, the document at

https://github.com/OctopusDeploy/docs/blob/master/docs/installation/installing-octopus/permissions-required-for-the-octopus-windows-service.md

gives a breakdown of what permissions need to be applied as a minimum. However on applying these on a Windows 2012 R2 server, the service still wouldn't start up. To get it working I had to run:

"netsh http add urlacl url=http://+:80/ user=$svcAccount"

Can the documentation be updated to reflect this?

Thanks.

I have a fork of this repository with actions enabled (this is a common state for forks and should be encouraged).

When I refreshed main, the build-astro workflow failed.

It's possible to avoid failing by either checking for secrets -- this requires a bit of:

env:
  has_secret1: ${{ secrets.secret1 != '' }}
  if: ${{ env.has_secret1 }}

or using an if: github.repository_owner -- I don't recommend this practice, but it does work if you don't want to let forks set up their own secrets to run workflows.

Any chance dark mode support is on the radar for the documentation site? So bright 😎

Following the steps in reporting getting started

First, **[download the template](/docs/attachments/download the template)** and open it in Excel.

The link is directing to missing/not found 404

The page, Deploy to a Kubernetes cluster is outdated and does not reflect the current state of Octopus. This page needs to be updated to reflect the change made to the step name and its behaviour. The step name is now Configure and apply Kubernetes resources.

We have a link to an Excel template on one of our reporting pages that is returning a 404.

I've tested the link when running the docs site locally and it works.

I can see the file being copied to the output folder when building the docs so I'm not sure what is different when the site is running in Production versus running locally.

👉 Docker Hub - Octopus Deploy

The image located at the bottom of the page shows a feed type specified as NuGet. This is incorrect. It should be Docker Container Registry.

Hi,

There is a document which describes feature ordering for package deployment:
https://github.com/OctopusDeploy/docs/blob/05a6393f428ecbdcf0dc5693f4df03f20af07cf3/docs/deployments/packages/package-deployment-feature-ordering.md

However, it's doesn't mention "Windows Service" feature, so it's not clear at which point windows service stop and configuration occurs.

Online (https://octopus.com/docs/) I only find documentation for versions down to 3.6. On our infrastructure, we are running version 3.4. Is the old documentation available somewhere?

Following the instructions here fails when running pnpm dev with the following error:

> pnpm dev

> @octopus/[email protected] dev /home/henrik/code/octopusdeploy/docs
> node --no-experimental-fetch ./src/themes/accelerator/utilities/img.mjs && astro dev

/home/henrik/code/octopusdeploy/docs/node_modules/.pnpm/[email protected]/node_modules/sharp/lib/sharp.js:107
  throw new Error(help.join('\n'));
        ^

Error: Could not load the "sharp" module using the linux-x64 runtime
Possible solutions:
- Ensure optional dependencies can be installed:
    npm install --include=optional sharp
    yarn add sharp --ignore-engines
- Ensure your package manager supports multi-platform installation:
    See https://sharp.pixelplumbing.com/install#cross-platform
- Add platform-specific dependencies:
    npm install --os=linux --cpu=x64 sharp
    npm install --force @img/sharp-linux-x64
- Consult the installation documentation:
    See https://sharp.pixelplumbing.com/install
    at Object.<anonymous> (/home/henrik/code/octopusdeploy/docs/node_modules/.pnpm/[email protected]/node_modules/sharp/lib/sharp.js:107:9)
    at Module._compile (node:internal/modules/cjs/loader:1254:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)
    at Module.load (node:internal/modules/cjs/loader:1117:32)
    at Module._load (node:internal/modules/cjs/loader:958:12)
    at Module.require (node:internal/modules/cjs/loader:1141:19)
    at require (node:internal/modules/cjs/helpers:110:18)
    at Object.<anonymous> (/home/henrik/code/octopusdeploy/docs/node_modules/.pnpm/[email protected]/node_modules/sharp/lib/constructor.js:10:1)
    at Module._compile (node:internal/modules/cjs/loader:1254:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)

Node.js v18.15.0
 ELIFECYCLE  Command failed with exit code 1.

node/npm/pnpm info:

> node -v
v18.15.0
> npm -v
9.5.0
> pnpm -v
8.11.0

Linux distribution info:

> lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 22.04.3 LTS
Release:	22.04
Codename:	jammy

The "Logging messages from scripts" document only documents the raw format for setting the log level of messages, but is missing the documentation for setting the progress level when not using any undocumented language.

https://github.com/OctopusDeploy/docs/blob/d79e7ff0bc76403b8c1dc08ba1aa6c5ddd458116/docs/api-and-integration/teamcity.md

The video below demonstrates how to do this.

The video below is from a webinar hosted by JetBrains in which we demonstrated these features:

No videos are linked however

On the output variables docs page, the tab lists for different scripting types overlay the page headers. Adding a z-index to the headers looks to fix this. I've only tested it in the browser on that single page.

I have converted this article to use curl:

# Upload file content
curl -v -X PUT -F [email protected] -H "X-Octopus-ApiKey: ${OCTOPUS_API_KEY}" "${uploadUrl}"

Unfortunatelly it includes http part data:

--------------------------246875bc4e54cce7
Content-Disposition: form-data; name="fileData"; filename="report.html"
Content-Type: text/html

<!DOCTYPE html>
<html lang="en">

This is big issue for binary files, I can live with it for text ones.

Probably it is issue with octopus itself not with documentation so please move this issue to the right place.

See page: https://octopus.com/docs/api-and-integration/octo.exe-command-line/creating-releases

This page has lead to some confusion and a fair bit of lost effort and time, there are 2 issues.

1. The [options] section states that switches are provided in --SWITCH=VALUE when the examples describe --SWITCH _space_ VALUE
2. The [options] section states that the --package switch can override the "Version number to use for a package in the release" however it overrides the package for a STEP in the release process.

The former issue certainly added some confusion as I was unsure as to whether iI was passing the switches to octo.exe correctly, however the latter issue is by far the most obscure and confusing.

Please can the documentation be clarified to prevent further confusion by people using octo.exe, including your support staff (see http://help.octopusdeploy.com/discussions/questions/7042-defaultpackageversion-package).

Also is it possible to explain/describe the reasons for why the "name of the step" needs to be specified; when it could reference a step which has nothing todo with deploying packages (e.g. a custom deployment step). When creating a release through the UI you select the packages not the packages for each step, hence the confusion here.

https://github.com/OctopusDeploy/docs/blob/master/docs/octopus-rest-api/how-to-create-an-api-key.md

This shows the old Octopus Dashboard.

Can this be updated please.

The documentation on Create Octopack > Adding a NuSpec file makes it sound like the NuSpec file will always get picked up as long as it has the same name as the project file. I've found that this isn't true; setting the OctoPackProjectName MSBuild param will also change the behavior so that it looks for a NuSpec with that name instead of the project name.

Also, this part of the documentation should have information on the OctoPackNuSpecFileName MSBuild param, which is how you can resolve the above. I only found information about that param on a forum post

Thanks!!