Merge pull request 'docs: 📝 Adds license and README with usage examples' (#2) from doc/add-readme into main
Reviewed-on: #2
This commit is contained in:
commit
5fda8069ce
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2024 Florian Beisel
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
# Gitea account registration Bot for Discord
|
||||
|
||||
This repository contains the source code for a Discord bot that interacts with Gitea to allow user self-registration from
|
||||
within Discord. It's designed to work across multiple platforms, including Docker, Windows, Linux, and macOS.
|
||||
|
||||
## Description
|
||||
|
||||
This Discord bot is designed to react to commands on Discord and interact with the Gitea API to create and manage user
|
||||
accounts. It currently supports the `!register` command to facilitate user registration through Discord.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
The bot requires the following environment variables to be set:
|
||||
|
||||
- `DISCORD_TOKEN`: The token for your Discord bot.
|
||||
- `GITEA_TOKEN`: The API token for accessing Gitea.
|
||||
- `GITEA_URL`: The base URL of your Gitea instance.
|
||||
|
||||
## Build it yourself
|
||||
|
||||
To build the bot from source, follow these steps:
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone https://git.beisel.it/beisel.org/gitea-register-account-bot.git
|
||||
```
|
||||
|
||||
2. Navigate to the cloned directory:
|
||||
|
||||
```bash
|
||||
cd gitea-register-account-bot
|
||||
```
|
||||
|
||||
3. Build the binary (ensure you have Go installed):
|
||||
|
||||
```bash
|
||||
go build -o gitea-register-account-bot
|
||||
```
|
||||
|
||||
### Creating a Docker Image
|
||||
|
||||
You may also create a Docker image using the provided Dockerfile:
|
||||
|
||||
1. Build the Docker image:
|
||||
|
||||
```bash
|
||||
docker build -t gitea-register-account-bot:latest .
|
||||
```
|
||||
|
||||
2. Run the Docker container:
|
||||
|
||||
```bash
|
||||
docker run -d --name gitea-register-account-bot -e DISCORD_TOKEN=your_token -e GITEA_TOKEN=your_token -e GITEA_URL=your_url gitea-register-account-bot:latest
|
||||
```
|
||||
|
||||
## Using the Prebuilt Images and binaries
|
||||
|
||||
We provide versioned as well as nightly builds through our CI/CD pipeline, where `:nightly` refers to an automatic build from
|
||||
the latest commit on the `main` branch. The latest release-version can be found with the `latest` Tag.
|
||||
|
||||
### Using the Prebuilt Docker Image
|
||||
|
||||
To use the prebuilt Docker image:
|
||||
|
||||
1. Pull the `latest` image from the registry:
|
||||
|
||||
```bash
|
||||
docker pull git.beisel.it/beisel.org/gitea-register-account-bot:latest
|
||||
```
|
||||
|
||||
2. Run the Docker container:
|
||||
|
||||
```bash
|
||||
docker run -d --name gitea-register-account-bot -e DISCORD_TOKEN=your_token -e GITEA_TOKEN=your_token -e GITEA_URL=your_url git.beisel.it/beisel.org/gitea-register-account-bot:latest
|
||||
```
|
||||
|
||||
### Running Prebuilt Binaries
|
||||
|
||||
Prebuilt binaries for Windows, Linux, and macOS are available in the releases section of this repository.
|
||||
|
||||
To run the binary:
|
||||
|
||||
1. Download the appropriate binary for your system.
|
||||
2. Make it executable (Linux/macOS):
|
||||
|
||||
```bash
|
||||
chmod +x gitea-register-account-bot-nightly-[linux-amd64,darwin-amd64]
|
||||
```
|
||||
|
||||
3. Run the binary:
|
||||
|
||||
```bash
|
||||
DISCORD_TOKEN=your_discord_token GITEA_TOKEN=your_gitea_token GITEA_URL=your_gitea_url ./gitea-register-account-bot-nightly-[linux-amd64,darwin-amd64]
|
||||
```
|
||||
|
||||
For Windows, simply execute the .exe file after setting your environment variables.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions to this project are welcome. Please ensure you follow the existing code style.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Support
|
||||
|
||||
For support, please open an issue in the repository, or hit me up on the Gitea discord @pacey.
|
||||
Loading…
Reference in New Issue