AlchemyCMS 技术文档

1. 安装指南

独立安装

如果还没有 Rails 项目或者想先试用 Alchemy，可以使用以下 Rails 模板。

首先确保已安装 Rails：

$ gem install rails

然后创建一个新的 Rails 项目：

$ rails new -m https://raw.githubusercontent.com/AlchemyCMS/rails-templates/master/all.rb <项目名称>

按照屏幕上的指示操作。

手动安装

如果想在 Rails 项目中手动安装 Alchemy，请按照以下步骤操作。

添加 Alchemy gem

在 Gemfile 中添加 Alchemy：

$ bundle add alchemy_cms

设置认证用户

需要决定是使用自己的用户模型还是使用 Alchemy 提供的基于 Devise 的用户模型。

使用 Alchemy 用户

如果没有自己的用户类，可以直接使用 Alchemy 用户模型。只需在 Gemfile 中添加以下 gem：

$ bundle add alchemy-devise

然后运行 alchemy-devise 安装程序：

$ bin/rails g alchemy:devise:install

使用自己的用户模型

如果要使用自己的用户模型，需要告诉 Alchemy。

最佳实践是使用初始化文件：

# config/initializers/alchemy.rb
Alchemy.user_class_name     = 'YourUserClass'          # 默认为 'User'
Alchemy.current_user_method = 'current_admin_user'     # 默认为 'current_user'
Alchemy.signup_path         = '/your/signup/path'      # 默认为 '/signup'
Alchemy.login_path          = '/your/login/path'       # 默认为 '/login'
Alchemy.logout_path         = '/your/logout/path'      # 默认为 '/logout'
Alchemy.logout_method       = 'http_verb_for_logout'   # 默认为 'delete'
Alchemy.unauthorized_path   = '/some/public/page'      # 默认为 '/'

Alchemy 需要从用户类中知道的是 alchemy_roles 方法。

该方法需要返回一个包含以下至少一个角色的数组或 ActiveRecord::Relation：member、author、editor、admin。

安装 Alchemy 到应用中：

设置用户模型后，需要运行 Alchemy 安装任务：

$ bin/rails alchemy:install

现在一切应该已经设置完毕，可以访问 Alchemy 仪表板：

http://localhost:3000/admin

*) 如果将 Alchemy 挂载到除 '/' 以外的其他路径，请使用自定义路径。

2. 项目使用说明

AlchemyCMS 是一个基于 Ruby on Rails 的开源 CMS 引擎，具有灵活的模板、丰富的 RESTful API、直观的管理界面等特点。

要使用 AlchemyCMS，请先按照安装指南进行安装。安装完成后，可以通过访问上面提供的仪表板地址来管理内容。

3. 项目API使用文档

AlchemyCMS 提供了一个丰富的 RESTful API，允许开发人员以编程方式访问和管理内容。

具体 API 使用方法和文档，请参考项目官方指南。

4. 项目安装方式

项目可以通过以下方式安装：

• 独立安装：使用提供的 Rails 模板创建新项目。
• 手动安装：在现有 Rails 项目中添加 Alchemy gem，并按照指南设置用户模型和运行安装任务。