Skip to content

Commit

Permalink
feat: support tabs
Browse files Browse the repository at this point in the history
  • Loading branch information
wacmkxiaoyi committed Dec 17, 2024
1 parent 04a948c commit a9158cf
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 62 deletions.
2 changes: 1 addition & 1 deletion manual/api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ set ZINC_FIRST_ADMIN_USER=admin
set ZINC_FIRST_ADMIN_PASSWORD=Complexpass#123
```
!!! tip
In most scenarios, you can use the administrator account to provide access for applications. Only when you need to integrate multiple applications with different permissions, you should create regular users.
In most scenarios, you can use the administrator account to provide access for applications. Only when you need to integrate multiple applications with different permissions, you should create regular users.


## Regular Users
Expand Down
2 changes: 1 addition & 1 deletion manual/api/document_operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
An index stores multiple documents. Users can perform CRUD operations (Create, Read, Update, Delete) on documents via the API. In SeaSearch, each document has a unique ID.

!!! tip
Due to architectural design, SeaSearch’s performance for single document CRUD operations is much lower than that of ElasticSearch. Therefore, we recommend using batch operations whenever possible.
Due to architectural design, SeaSearch’s performance for single document CRUD operations is much lower than that of ElasticSearch. Therefore, we recommend using batch operations whenever possible.

ElasticSearch Document APIs contain many additional parameters that are not meaningful to SeaSearch and are not supported. All query parameters are unsupported.

Expand Down
120 changes: 60 additions & 60 deletions manual/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,67 +40,67 @@ These configurations are only effective when `SS_STORAGE_TYPE=s3`.

### Enabling S3 as Storage Backend
=== "AWS"
``` sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_REGION=us-east-1
SS_S3_USE_HTTPS=true
SS_S3_USE_V4_SIGNATURE=true
```
``` sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_REGION=us-east-1
SS_S3_USE_HTTPS=true
SS_S3_USE_V4_SIGNATURE=true
```
=== "Exoscale"
``` sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_ENDPOINT=sos-de-fra-1.exo.io
SS_S3_PATH_STYLE_REQUEST=true
```
``` sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_ENDPOINT=sos-de-fra-1.exo.io
SS_S3_PATH_STYLE_REQUEST=true
```
=== "Hetzner"
``` sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_ENDPOINT=fsn1.your-objectstorage.com
SS_S3_PATH_STYLE_REQUEST=true
SS_S3_USE_HTTPS=true
```
``` sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_ENDPOINT=fsn1.your-objectstorage.com
SS_S3_PATH_STYLE_REQUEST=true
SS_S3_USE_HTTPS=true
```
=== "Other Public Hosted S3 Storag"
```sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_ENDPOINT=<access endpoint for storage provider>
SS_S3_REGION=<region name for storage provider>
SS_S3_USE_HTTPS=true
```
```sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_ENDPOINT=<access endpoint for storage provider>
SS_S3_REGION=<region name for storage provider>
SS_S3_USE_HTTPS=true
```
=== "Self-hosted S3 Storage"
```sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_ENDPOINT=<your s3 api endpoint host>:<your s3 api endpoint port>
SS_S3_USE_HTTPS=true
SS_S3_PATH_STYLE_REQUEST=true
SS_S3_USE_HTTPS=true
```
```sh
ZINC_FIRST_ADMIN_USER=admin
ZINC_FIRST_ADMIN_PASSWORD=password
SS_DATA_PATH=./data
SS_STORAGE_TYPE=s3
SS_S3_ACCESS_ID=<your-s3-key-id>
SS_S3_ACCESS_SECRET=<your-s3-secret-key>
SS_S3_BUCKET=<your-seasearch-bucket>
SS_S3_ENDPOINT=<your s3 api endpoint host>:<your s3 api endpoint port>
SS_S3_USE_HTTPS=true
SS_S3_PATH_STYLE_REQUEST=true
SS_S3_USE_HTTPS=true
```
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ markdown_extensions:
- markdown.extensions.toc:
permalink: true
toc_depth: "1-4"
- pymdownx.tabbed:
alternate_style: true

# Page tree
nav:
Expand Down

0 comments on commit a9158cf

Please sign in to comment.