Download instructions (#1276)
## Description
Explicit download instructions
## Type of change
- [x] 🗺️ Documentation
This commit is contained in:
parent
c0453c44b5
commit
78a605ec5c
@ -9,7 +9,8 @@
|
||||
"img",
|
||||
"div",
|
||||
"Tabs",
|
||||
"TabItem"
|
||||
"TabItem",
|
||||
"CodeBlock"
|
||||
]
|
||||
},
|
||||
}
|
||||
|
||||
@ -1,5 +1,10 @@
|
||||
# Downloads
|
||||
|
||||
import CodeBlock from '@theme/CodeBlock';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import {Version} from '@site/src/corsoEnv';
|
||||
|
||||
Corso is available as a Docker container image or as native binaries.
|
||||
|
||||
## Docker container images
|
||||
@ -13,7 +18,82 @@ We strongly recommend using a container image with the release version tag (for
|
||||
`ghcr.io/alcionai/corso:v0.1.0`) but container images with the `latest` tag are also available. Unreleased builds
|
||||
with the `nightly` tag are also provided for testing but these are likely to be unstable.
|
||||
|
||||
<Tabs groupId="docker">
|
||||
<TabItem value="release" label="Official Release">
|
||||
|
||||
<CodeBlock language="bash">{
|
||||
`docker pull ghcr.io/alcionai/corso:${Version()}`
|
||||
}</CodeBlock>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="latest" label="Latest">
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/alcionai/corso:latest
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="nightly" label="Nightly (Unstable)">
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/alcionai/corso:nightly
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Native binaries
|
||||
|
||||
Corso is also available as an `x86_64` and `arm64` executable for Windows, Linux and macOS. These can be downloaded from
|
||||
the [GitHub releases page](https://github.com/alcionai/corso/releases).
|
||||
|
||||
<!-- vale Vale.Spelling = NO -->
|
||||
<!-- markdownlint-disable MD034 -->
|
||||
|
||||
<Tabs groupId="download">
|
||||
<TabItem value="win" label="Windows (Powershell)">
|
||||
|
||||
<CodeBlock language="powershell">{
|
||||
`Invoke-WebRequest \`
|
||||
-Uri https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Windows_x86_64.tar.gz \`
|
||||
-UseBasicParsing -Outfile corso_${Version()}_Windows_x86_64.tar.gz
|
||||
tar zxvf .\\corso_${Version()}_Windows_x86_64.tar.gz`
|
||||
}</CodeBlock>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="linux-arm" label="Linux - arm64">
|
||||
|
||||
<CodeBlock language="bash">{
|
||||
`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_arm64.tar.gz && \\
|
||||
tar zxvf corso_${Version()}_Linux_arm.tar.gz`
|
||||
}</CodeBlock>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="linux-x86-64" label="Linux - x86_64">
|
||||
|
||||
<CodeBlock language="bash">{
|
||||
`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_x86_64.tar.gz && \\
|
||||
tar zxvf corso_${Version()}_Linux_x86_64.tar.gz`
|
||||
}</CodeBlock>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos-arm" label="macOS - arm64">
|
||||
|
||||
<CodeBlock language="bash">{
|
||||
`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_arm64.tar.gz && \\
|
||||
tar zxvf corso_${Version()}_Darwin_arm.tar.gz`
|
||||
}</CodeBlock>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos-x86-64" label="macOS - x86_64">
|
||||
|
||||
<CodeBlock language="bash">{
|
||||
`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_x86_64.tar.gz && \\
|
||||
tar zxvf corso_${Version()}_Darwin_x86_64.tar.gz`
|
||||
}</CodeBlock>
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<!-- vale Vale.Spelling = YES -->
|
||||
<!-- markdownlint-enable MD034 -->
|
||||
|
||||
@ -33,6 +33,10 @@ const config = {
|
||||
require.resolve('docusaurus-plugin-image-zoom')
|
||||
],
|
||||
|
||||
customFields: {
|
||||
corsoVersion: `${process.env.CORSO_VERSION}`,
|
||||
},
|
||||
|
||||
presets: [
|
||||
[
|
||||
'classic',
|
||||
|
||||
7
docs/src/corsoEnv.js
Normal file
7
docs/src/corsoEnv.js
Normal file
@ -0,0 +1,7 @@
|
||||
import React from 'react';
|
||||
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||
|
||||
export const Version = () => {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return siteConfig.customFields.corsoVersion;
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user