mirror of
https://github.com/shiroyashik/sculptor.git
synced 2025-12-06 04:51:13 +03:00
Upgrade/Migrate to newer dependencies (check diff Cargo.toml)
Some checks failed
Push Dev / docker (push) Has been cancelled
Some checks failed
Push Dev / docker (push) Has been cancelled
+ Rename: api/v1 to api/sculptor
This commit is contained in:
parent
59ca04d5f8
commit
c7c3bd881f
20 changed files with 470 additions and 390 deletions
19
README.md
19
README.md
|
|
@ -35,7 +35,7 @@ To run it you will need a configured reverse proxy server.
|
|||
|
||||
Make sure that the reverse proxy you are using supports WebSocket and valid certificates are used for HTTPS connections.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> [!WARNING]
|
||||
> NGINX requires additional configuration to work with websocket!
|
||||
|
||||
### Docker
|
||||
|
|
@ -57,10 +57,10 @@ See the [pre-built archives](https://github.com/shiroyashik/sculptor/releases/la
|
|||
A pre-installed Rust will be required for the build
|
||||
|
||||
```sh
|
||||
# Clone the latest release
|
||||
# Clone the pre-release
|
||||
git clone https://github.com/shiroyashik/sculptor.git
|
||||
# or a dev release
|
||||
git clone --branch dev https://github.com/shiroyashik/sculptor.git
|
||||
# or clone specific version
|
||||
git clone --depth 1 --branch v0.4.0 https://github.com/shiroyashik/sculptor.git
|
||||
# Enter the folder
|
||||
cd sculptor
|
||||
# Copy Sculptor configuration file
|
||||
|
|
@ -73,6 +73,13 @@ cargo build --release
|
|||
cargo run --release
|
||||
```
|
||||
|
||||
#### Compiling from the `master` Branch
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Installing Sculptor directly from the `master` branch is **not recommended** for most users. This branch contains pre-release code that is actively being developed and may include broken or unstable features. Additionally, using the `master` branch could potentially cause issues with data migration when upgrading to future stable releases.
|
||||
>
|
||||
> If you still choose to use the `master` branch, please be aware that you may encounter bugs or unexpected behavior. Your feedback and bug reports are highly appreciated. However, for a more stable and reliable experience, we strongly advise using the **latest official release** instead.
|
||||
|
||||
## Contributing
|
||||

|
||||
on
|
||||
|
|
@ -92,10 +99,6 @@ If you are a Rust developer, you can modify the code yourself and request a Pull
|
|||
|
||||
Glad for any help from ideas to PRs. ❤
|
||||
|
||||
#### P.S.
|
||||
|
||||
The [“master”](https://github.com/shiroyashik/sculptor/tree/master) branch contains the source code of the latest release. [“dev”](https://github.com/shiroyashik/sculptor/tree/dev) branch is used for development.
|
||||
|
||||
## License
|
||||
|
||||
The Sculptor is licensed under [GPL-3.0](LICENSE)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue