Skip to content

Manager v3 Docs #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
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
4 changes: 4 additions & 0 deletions docs/installations/methods/manager/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Command Line",
"position": 1
}
40 changes: 40 additions & 0 deletions docs/installations/methods/manager/cli/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: SnailyCAD Manager CLI
---

import CodeBlock from "@theme/CodeBlock";

## Introduction

SnailyCAD Manager v3 comes with a CLI tool that allows you to manage SnailyCAD Manager's settings, as well as manage environment variables for each instance. (More features will be added in the future)

## Usage

The CLI tool can be accessed by running `scm` in your terminal. This will show you the available commands/flags.

<CodeBlock>

<span
style={{
color: "rgba(248, 248, 242, .3)",
}}
>
{"> scm\n\n"}
</span>

{"Usage: scm <command> [options]\n\n"}

<div>
<span style={{ color: "rgba(248, 248, 242, .7)" }}>{"Commands:\n"}</span>
<span>{" password-reset Reset the admin password\n"}</span>
<span>
{" env Read or set environment variables for the provided instance ID\n"}
</span>
<span>{" settings Read or set settings for the provided instance ID\n"}</span>
<br />
<span style={{ color: "rgba(248, 248, 242, .7)" }}>{"Options:\n"}</span>
<span>{" -h, --help Show help\n"}</span>
<span>{" -v, --version Show version number\n"}</span>
</div>

</CodeBlock>
17 changes: 0 additions & 17 deletions docs/installations/methods/manager/env-configuration.mdx

This file was deleted.

64 changes: 49 additions & 15 deletions docs/installations/methods/manager/manager.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,71 @@
sidebar_position: 1
---

import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

# SnailyCAD Manager Installation

This guide will help you install a new SnailyCAD instance or use an exisiting SnailyCAD instance using the SnailyCAD Manager.
This guide will help you to install SnailyCAD Manager on your operating system of choice, quickly and easily. SnailyCAD Manager is a desktop application that allows you to manage instances of SnailyCAD with ease.

### 1. Requirements

#### 1.2. General Requirements
Before you start, make sure you have the following requirements installed on your system:

All the items listed below are required to get the CAD up and running smoothly.
:::important
SnailyCAD Manager now supports both Windows and Linux with the release of v3!
:::

- [Git](https://git-scm.com/downloads) ([Windows Guide](https://youtu.be/EsNgheQPZs4)) ([Linux Guide](/docs/guides/requirements/how-to-install-git-linux))
- [Node.js](https://nodejs.org) **(18.x is supported.)** ([Windows Guide](https://youtu.be/qfo5MaqQgIo)) ([Linux Guide](/docs/guides/requirements/how-to-install-node-pnpm-npm-linux))
- [pnpm](https://pnpm.io/installation) ([Windows Guide](https://youtu.be/qfo5MaqQgIo)) ([Linux Guide](/docs/guides/requirements/how-to-install-node-pnpm-npm-linux))
- [PostgreSQL](https://www.postgresql.org/download/) **(version 14 or higher)** ([Video Guide](https://www.youtube.com/watch?v=ZKWZvafvqwM)) ([Linux Guide](/docs/guides/requirements/how-to-install-postgresql-linux))

#### 1.3. System Requirements
### 2. Installation

Please select the operating system you are using to install SnailyCAD Manager:

<Tabs groupId="manager-os">
<TabItem value="windows" label="Windows" default>

[Download the latest version of SnailyCAD Manager](https://github.com/SnailyCAD-Manager/v3/releases/latest/download/snailycad-manager.exe) and run the installer.

SnailyCAD is now installed and ready to use. SnailyCAD Manager v3 is available by default at [`http://localhost:60120`](http://localhost:60120).

Please view the [CLI Guide](/docs/installations/methods/manager/cli) for more information on how to use the command line interface to change SnailyCAD Manager's settings, and more.

:::tip
SnailyCAD Manager v3 will work with a reverse proxy, if you wish to set one up!
:::

</TabItem>

<TabItem value="linux" label="Linux">

Open your terminal

Run the following command to set yourself as the root user (required):

```bash
sudo -i
```

Run the following command to download the latest version of SnailyCAD Manager:

- OS: `Windows`
- vCPU's/CPU's: `>=2`
- RAM: `>=4gb`
- Proxy: `Apache` or `NGINX`
```bash
pnpm create snailycad-manager
```

### 2. Downloading
Done 🎉

[You can download the latest version of the SnailyCAD Manager here](https://snailycad.org/manager)
SnailyCAD Manager v3 is available at `YOUR_SERVER_IP:60120` by default, and is port forwarded by default.

### 3. Setup
Please view the [CLI Guide](/docs/installations/methods/manager/cli) for more information on how to use the command line interface to change SnailyCAD Manager's settings, and more.

Once you've downloaded the latest version of the SnailyCAD Manager, you can start the setup process:
:::tip
SnailyCAD Manager v3 will work with a reverse proxy, if you wish to set one up!
:::

- [New SnailyCAD instance](/docs/installations/methods/manager/setup-wizard/new-instance)
- [Existing SnailyCAD instance](/docs/installations/methods/manager/setup-wizard/existing-instance)
</TabItem>

_These docs were originally written by [Whitigol](https://whitigol.me)_
</Tabs>

This file was deleted.

This file was deleted.

54 changes: 0 additions & 54 deletions docs/installations/methods/manager/setup-wizard/new-instance.mdx

This file was deleted.

Loading