https://github.com/wuhan005/NekoBox
📫 匿名提问箱 / Anonymous question box
https://github.com/wuhan005/NekoBox
anonymous-chat flamego go golang production saas side-project
Last synced: 15 days ago
JSON representation
📫 匿名提问箱 / Anonymous question box
- Host: GitHub
- URL: https://github.com/wuhan005/NekoBox
- Owner: wuhan005
- License: mit
- Created: 2020-03-13T07:51:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-09-19T16:07:24.000Z (19 days ago)
- Last Synced: 2025-09-19T16:39:13.395Z (19 days ago)
- Topics: anonymous-chat, flamego, go, golang, production, saas, side-project
- Language: Go
- Homepage: https://box.n3ko.cc
- Size: 5.29 MB
- Stars: 264
- Watchers: 4
- Forks: 33
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
NekoBox
匿名提问箱 / Anonymous Question Box
## Deployment
### Docker Deployment
1. Create a Configuration File
Create a configuration file `app.ini` based on the template `conf/app.sample.ini`. Adjust the settings as needed by
referring to the comments in the file.
2. Start the Container
```bash
# Pull the latest image
docker pull ghcr.io/wuhan005/nekobox:master
# Start the container (listen on port 80 and mount the configuration file)
docker run -dt --name NekoBox -p 80:80 -v $(pwd)/app.ini:/app/conf/app.ini ghcr.io/wuhan005/nekobox:master
```
### Build from Source
1. Requirements
* [Go](https://golang.org/dl/) (v1.19 or higher)
* [MySQL](https://www.mysql.com/downloads/) (v5.7 or higher)
* [Redis](https://redis.io/download/) (v6.0 or higher)
2. Compile the Source Code
```bash
# Clone the source code
git clone https://github.com/wuhan005/NekoBox.git
# Enter the project directory
cd NekoBox
# Build the binary for the current system and architecture
go build -v -ldflags "-w -s -extldflags '-static'" -o NekoBox ./cmd/
# Build the binary for Linux, AMD64 architecture
GOOS=linux GOARCH=amd64 go build -v -ldflags "-w -s -extldflags '-static'" -o NekoBox ./cmd/
```
3. Edit the Configuration File
Create a configuration file based on the template `conf/app.sample.ini`. Adjust the settings as needed by referring to
the comments in the file.
```bash
cp conf/app.sample.ini conf/app.ini
```
4. Run
```bash
./NekoBox web
```
## License
MIT License
