Skip to content

Latest commit

 

History

History
 
 

guide

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

README.md

sidebar auto

使用帮助

简介

bbs-go 为前后端分离设计,后端接口服务(server端)由Go语言开发,前端网页服务(site端)由Nodejs开发。所以在部署的时候要分别部署server端和site端。

bbs-go 系统是支持跨平台的,理论上支持在所有平台上进行部署,目前在主流平台(如:Linux、MacOs、Windows)已经有很多部署成功案例。

server 端部署

环境搭建

首先确保你已经成功在本地安装好了go语言开发环境,如果环境不会安装的,请参照下面文章:

编译

Go语言是支持交叉编译的,你可以在Windows系统中将他编译成可以在Linux系统上可执行的二进制文件,其他平台同理。

编译时请打开命令行,并cd进入bbs-go/server目录,然后按照下面步骤进行编译。

  • 如果只想编译当前机器可执行文件,那么只需要执行以下命令即可:
go build
  • 如果想编译其他类型系统可执行二进制文件(例如在Windows系统中编译Linux系统上的可执行文件),可以执行以下命令:
# 1. 设置系统类型
SET GOOS=linux
# 2. 设置CPU架构
SET GOARCH=amd64
# 3. 编译
go build

注意在其他类Unix系统(如Linux、MacOS)中设置系统类型和CPU架构的方式和在Windows系统中不太一样,在类Unix系统中实现上面同样效果,命令如下:

GOOS=linux GOARCH=amd64 go build

编译后会在bbs-go/server目录下生成一个bbs-go文件(Windows下是bbs-go.exe),这个就是我们编译后的可执行文件。

配置

首先将文件bbs-go/server/bbs-go.example.yaml复制一份,重命名为:bbs-go/server/bbs-go.yaml。这个文件中对于每个配置项都做了详细注释说明,请按照注释配置即可。这里我们着重讲解一下数据库的配置,数据库为必要配置,成功配置数据库之后就可以正常启动bbs-go服务了。

bbs-go数据库使用的是MySql,mysql最低版本要求为5.7(或者MariaDB 10及以上版本)。数据库的安装这里就不做赘述了,如果不会可自行百度/Google。

数据库成功安装之后,请通过工具(工具自行选择,我喜欢用mysql-cli,也可以用Navicat、TablePlus、MySQLWorkbench...)连接数据库,然后使用以下Sql脚本创建bbs-go所需的数据库表,并做简单的初始化,脚本如下:

==备注:Sql脚本会初始化默认管理员用户,用户名:admin 密码:123456==

CREATE DATABASE IF NOT EXISTS `bbsgo_db` DEFAULT CHARACTER SET utf8mb4;

USE bbsgo_db;
SET NAMES utf8mb4;

-- 初始化用户表
CREATE TABLE `t_user`
(
    `id`                 bigint(20) NOT NULL AUTO_INCREMENT,
    `username`           varchar(32)         DEFAULT NULL,
    `email`              varchar(128)        DEFAULT NULL,
    `email_verified`     tinyint(1) NOT NULL DEFAULT '0',
    `nickname`           varchar(16)         DEFAULT NULL,
    `avatar`             text,
    `background_image`   text,
    `password`           varchar(512)        DEFAULT NULL,
    `home_page`          varchar(1024)       DEFAULT NULL,
    `description`        text,
    `score`              bigint(20) NOT NULL,
    `status`             bigint(20) NOT NULL,
    `topic_count`        bigint(20) NOT NULL,
    `comment_count`      bigint(20) NOT NULL,
    `roles`              text,
    `type`               bigint(20) NOT NULL,
    `forbidden_end_time` bigint(20) NOT NULL DEFAULT '0',
    `create_time`        bigint(20)          DEFAULT NULL,
    `update_time`        bigint(20)          DEFAULT NULL,
    PRIMARY KEY (`id`),
    UNIQUE KEY `username` (`username`),
    UNIQUE KEY `email` (`email`),
    KEY `idx_user_score` (`score`),
    KEY `idx_user_status` (`status`)
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8mb4;

-- 初始化用户数据(用户名:admin、密码:123456)
INSERT INTO t_user (`id`, `username`, `nickname`, `avatar`, `email`, `password`, `status`, `create_time`, `update_time`,
                    `roles`, `type`, `description`, `topic_count`, `comment_count`, `score`)
SELECT 1,
       'admin',
       'bbsgo站长',
       '',
       'a@example.com',
       '$2a$10$ofA39bAFMpYpIX/Xiz7jtOMH9JnPvYfPRlzHXqAtLPFpbE/cLdjmS',
       0,
       (UNIX_TIMESTAMP(now()) * 1000),
       (UNIX_TIMESTAMP(now()) * 1000),
       'owner',
       0,
       '轻轻地我走了,正如我轻轻的来。',
       0,
       0,
       0
FROM DUAL
WHERE NOT EXISTS(SELECT * FROM `t_user` WHERE `id` = 1);


-- 初始化话题节点
CREATE TABLE `t_topic_node`
(
    `id`          bigint(20) NOT NULL AUTO_INCREMENT,
    `name`        varchar(32) DEFAULT NULL,
    `description` longtext,
    `sort_no`     bigint(20)  DEFAULT NULL,
    `status`      bigint(20) NOT NULL,
    `create_time` bigint(20)  DEFAULT NULL,
    PRIMARY KEY (`id`),
    UNIQUE KEY `name` (`name`),
    KEY `idx_sort_no` (`sort_no`)
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8mb4;

INSERT INTO `t_topic_node` (`id`, `name`, `description`, `sort_no`, `status`, `create_time`)
SELECT 1, '默认节点', '', 0, 0, (UNIX_TIMESTAMP(now()) * 1000)
FROM DUAL
WHERE NOT EXISTS(SELECT * FROM `t_topic_node` WHERE `id` = 1);

-- 初始化系统配置表
CREATE TABLE `t_sys_config`
(
    `id`          bigint(20)   NOT NULL AUTO_INCREMENT,
    `key`         varchar(128) NOT NULL,
    `value`       text,
    `name`        varchar(32)  NOT NULL,
    `description` varchar(128) DEFAULT NULL,
    `create_time` bigint(20)   NOT NULL,
    `update_time` bigint(20)   NOT NULL,
    PRIMARY KEY (`id`),
    UNIQUE KEY `key` (`key`)
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8mb4;

-- 初始化系统配置数据
INSERT INTO t_sys_config(`key`, `value`, `name`, `description`, `create_time`, `update_time`)
SELECT 'siteTitle',
       'bbs-go演示站',
       '站点标题',
       '站点标题',
       (UNIX_TIMESTAMP(now()) * 1000),
       (UNIX_TIMESTAMP(now()) * 1000)
FROM DUAL
WHERE NOT EXISTS(SELECT * FROM `t_sys_config` WHERE `key` = 'siteTitle');

INSERT INTO t_sys_config (`key`, `value`, `name`, `description`, `create_time`, `update_time`)
SELECT 'siteDescription',
       'bbs-go,基于Go语言的开源社区系统',
       '站点描述',
       '站点描述',
       (UNIX_TIMESTAMP(now()) * 1000),
       (UNIX_TIMESTAMP(now()) * 1000)
FROM DUAL
WHERE NOT EXISTS(SELECT * FROM `t_sys_config` WHERE `key` = 'siteDescription');

INSERT INTO t_sys_config (`key`, `value`, `name`, `description`, `create_time`, `update_time`)
SELECT 'siteKeywords',
       'bbs-go',
       '站点关键字',
       '站点关键字',
       (UNIX_TIMESTAMP(now()) * 1000),
       (UNIX_TIMESTAMP(now()) * 1000)
FROM DUAL
WHERE NOT EXISTS(SELECT * FROM `t_sys_config` WHERE `key` = 'siteKeywords');

INSERT INTO t_sys_config (`key`, `value`, `name`, `description`, `create_time`, `update_time`)
SELECT 'siteNavs',
       '[{\"title\":\"首页\",\"url\":\"/\"},{\"title\":\"话题\",\"url\":\"/topics\"},{\"title\":\"文章\",\"url\":\"/articles\"}]',
       '站点导航',
       '站点导航',
       (UNIX_TIMESTAMP(now()) * 1000),
       (UNIX_TIMESTAMP(now()) * 1000)
FROM DUAL
WHERE NOT EXISTS(SELECT * FROM `t_sys_config` WHERE `key` = 'siteNavs');

INSERT INTO t_sys_config (`key`, `value`, `name`, `description`, `create_time`, `update_time`)
SELECT 'defaultNodeId',
       '1',
       '默认节点',
       '默认节点',
       (UNIX_TIMESTAMP(now()) * 1000),
       (UNIX_TIMESTAMP(now()) * 1000)
FROM DUAL
WHERE NOT EXISTS(SELECT * FROM `t_sys_config` WHERE `key` = 'defaultNodeId');

INSERT INTO t_sys_config (`key`, `value`, `name`, `description`, `create_time`, `update_time`)
SELECT 'tokenExpireDays',
       '365',
       '用户登录有效期(天)',
       '用户登录有效期(天)',
       (UNIX_TIMESTAMP(now()) * 1000),
       (UNIX_TIMESTAMP(now()) * 1000)
FROM DUAL
WHERE NOT EXISTS(SELECT * FROM `t_sys_config` WHERE `key` = 'tokenExpireDays');

INSERT INTO t_sys_config (`key`, `value`, `name`, `description`, `create_time`, `update_time`)
SELECT 'scoreConfig',
       '{"postTopicScore":1,"postCommentScore":1,"checkInScore":1}',
       '积分配置',
       '积分配置',
       (UNIX_TIMESTAMP(now()) * 1000),
       (UNIX_TIMESTAMP(now()) * 1000)
FROM DUAL
WHERE NOT EXISTS(SELECT * FROM `t_sys_config` WHERE `key` = 'scoreConfig');

bbs-go数据库初始化完成之后,我们只需要修改bbs-go.yaml配置文件中的MySqlUrl配置即可。MySqlUrl配置主要有以下几个关键点:

  1. 数据库用户名,这里假设我们数据库的用户名是:root
  2. 数据库服务器地址,这里假设我们的配置是:localhost
  3. 数据库名,我们上面脚本创建的数据库名称为:bbs-go

那么我们的MySqlUrl配置如下:

MySqlUrl: root:123456@tcp(localhost:3306)/bbsgo_db?charset=utf8mb4&parseTime=True&loc=Local

运行

bbs-go的运行只需要两个文件,也就是我们上面步骤涉及到的两个文件:

  1. 编译好的可执行文件:bbs-go(Windows下是bbs-go.exe)
  2. 配置文件:bbs-go.yaml

将这两个文件放到同一个目录下,然后使用使用命令行进入到该目录中,在该目录下执行命令:

./bbs-go

即可启动bbs-go-server服务,启动成功后,控制台会输入如下日志:

Now listening on: http://localhost:8082
Application started. Press CMD+C to shut down.

bbs-go-server默认的端口是:8082(你也可以在bbs-go.yaml配置文件中自行修改),在浏览器中访问:http://localhost:8082 就可以看到效果了,浏览器会显示:Powered by bbs-go 。

site 端部署

安装nodejs环境

site 模块是基于nodejs开发的,所以编译他首先要安装nodejs环境。

安装依赖

在环境安装好后,进入到bbs-go/site目录,然后执行以下命令安装bbs-go-site模块所需依赖:

npm install

npm的软件源是在国外服务器的,所以安装起来可能比较慢,你也可以使用cnpm来安装依赖,首先要安装cnpm,安装命令如下:

npm install cnpm -g --registry=https://r.npm.taobao.org

cnpm安装完后,在bbs-go/site目录下执行以下命令安装依赖,效果同:npm install,速度会快很多,命令如下:

cnpm install

配置

site模块的配置很简单,只需要配置:server端服务地址即可。这里的server端就是指bbs-go-server运行的地址,也就是上面讲到的:http://localhost:8082(这里要根据你的具体情况而定)。配置方式是,打开`bbs-go/site/nuxt.config.js`,找到`proxy`配置项,将他修改为下面的配置即可:

  proxy: {
    '/api/': 'http://localhost:8082',
  },

运行

完成上面步骤之后,可以通过命令:npm run dev 以开发模式启动bbs-go-site。bbs-go-site服务默认端口为3000,启动成功后你就可以在浏览器通过:http://localhost:3000 访问和体验整个bbs-go的功能啦。

当然我们线上部署是不能使用:npm run dev方式执行的,向上部署方式如下:

  1. 使用npm run build编译site模块,编译成功后会在目录中生成.nuxt目录。
  2. 使用npm run start启动服务,服务同样启动在:3000 端口。