Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 2.46 KB

README.md

File metadata and controls

91 lines (65 loc) · 2.46 KB
Raw

NekoBox

匿名提问箱 / Anonymous Question Box

Go Report Card Sourcegraph DeepSource Go Report Card

简体中文 | English

Screenshot

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.

  1. Start the Container
# Pull the latest image
docker pull ghcr.io/nekowheel/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/nekowheel/nekobox:master

Build from Source

  1. Requirements
  • Go (v1.19 or higher)
  • MySQL (v5.7 or higher)
  • Redis (v6.0 or higher)
  1. Compile the Source Code
# Clone the source code
git clone https://github.com/NekoWheel/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/
  1. 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.

cp conf/app.sample.ini conf/app.ini
  1. Run
./NekoBox web

License

MIT License