Skip to content

Commit

Permalink
docs: initial draft of enterprise features (#1700)
Browse files Browse the repository at this point in the history
  • Loading branch information
wsxiaoys authored Mar 20, 2024
1 parent da76c16 commit 053318e
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 2 deletions.
3 changes: 3 additions & 0 deletions website/docs/administration/assets/webserver-running.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions website/docs/administration/backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
sidebar_position: 2
---

# Data Backup

:::info
We recommend regularly backing up the database to ensure data recovery in case of a failure. It's particularly advisable to back up before making significant changes such as upgrades or configuration modifications.
:::

By default, Tabby stores all its data in the `$HOME/.tabby` directory. However, you can override this behavior by using the `TABBY_ROOT` environment variable. This directory contains all the necessary data for Tabby's operation, including the database, logs, and configuration files.

## Database Backup

Tabby uses SQLite for data storage. You can back up the database by simply copying the file to a secure location. The database is located at `$HOME/.tabby/ee/db.sqlite` by default.

## Event Logs Backup

Tabby stores all event logs in the `~/.tabby/events` directory. These events, stored in JSON format, are named after the date of their creation.

```
% ls ~/.tabby/events
2023-11-24.json 2023-12-08.json 2024-01-09.json 2024-01-31.json 2024-02-10.json 2024-02-22.json 2024-03-06.json
2023-11-26.json 2023-12-09.json 2024-01-17.json 2024-02-01.json 2024-02-11.json 2024-02-23.json 2024-03-07.json
2023-11-28.json 2023-12-10.json 2024-01-18.json 2024-02-02.json 2024-02-12.json 2024-02-24.json 2024-03-10.json
2023-11-29.json 2023-12-11.json 2024-01-19.json 2024-02-03.json 2024-02-13.json 2024-02-25.json 2024-03-13.json
2023-11-30.json 2023-12-15.json 2024-01-21.json 2024-02-04.json 2024-02-14.json 2024-02-26.json 2024-03-20.json
2023-12-01.json 2023-12-16.json 2024-01-22.json 2024-02-05.json 2024-02-15.json 2024-02-27.json
2023-12-02.json 2023-12-18.json 2024-01-23.json 2024-02-06.json 2024-02-16.json 2024-03-01.json
2023-12-04.json 2023-12-19.json 2024-01-26.json 2024-02-07.json 2024-02-18.json 2024-03-02.json
2023-12-05.json 2023-12-20.json 2024-01-27.json 2024-02-08.json 2024-02-19.json 2024-03-03.json
2023-12-07.json 2023-12-22.json 2024-01-30.json 2024-02-09.json 2024-02-20.json 2024-03-05.json
```
15 changes: 15 additions & 0 deletions website/docs/administration/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
sidebar_position: 3
---

# 🔧 Administration

Tabby comes with an enhanced experience with a full feature UI interface and many enterprise facing features, it can be turned on by running the `--webserver` command.

```bash
tabby serve ... --webserver
```

The webserver will be available at `http://localhost:8080` by default.

![webserver](./assets/webserver-running.png)
21 changes: 21 additions & 0 deletions website/docs/administration/upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
sidebar_position: 1
---

# Upgrade

:::warning
Before upgrade, make sure to [back up](./backup) the database.
:::


Tabby is a fast-evolving project, and we are constantly adding new features and fixing bugs. To keep up with the latest improvements, you should regularly upgrade your Tabby installation.

# Upgrade Procedure

The standard procedure for upgrading Tabby involves the following steps:

1. Back up the Tabby database.
2. Restart Tabby.

That's it! You've successfully upgraded Tabby. If you encounter any issues, please consider joining our [slack community](https://links.tabbyml.com/join-slack) for help.
4 changes: 2 additions & 2 deletions website/docs/extensions/configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
sidebar_position: 98
---

# Advanced Configuration
# Configuration

This document describes the available configurations for Tabby IDE extensions.
This document describes the available configurations for [Tabby Agent](https://github.com/TabbyML/tabby/tree/main/clients/tabby-agent).

## Config File

Expand Down

0 comments on commit 053318e

Please sign in to comment.