versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2025-12-06 08:28:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Jesse Wierzbinski 2023-11-26 20:10:57 -10:00
parent 2fbe0a6c7b
commit 2c31884ada
No known key found for this signature in database
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -95,6 +95,30 @@ To run the server, simply run the following command:
bun start
```
### Using the CLI
Lysand includes a built-in CLI for managing the server. To use it, simply run the following command:
```bash
bun cli
```
You can use the `help` command to see a list of available commands. These include creating users, deleting users and more.
## With Docker
> **Note**: Docker would probably work perfectly fine, but it has not been tested, and as such there are no instructions for its usage with Lysand.
You can also run Lysand using Docker. To do so, you will need to build the Docker image:
```bash
# After cloning the repository
cd lysand
sudo docker compose build
```
The Docker build isn't ready for usage, so you will need to do things like running migrations and setting up the database manually.
## Contributing
Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.