Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serverless-components/tencent-laravel
Tencent Cloud Laravel Serverless Component
https://github.com/serverless-components/tencent-laravel
Last synced: 3 months ago
JSON representation
Tencent Cloud Laravel Serverless Component
- Host: GitHub
- URL: https://github.com/serverless-components/tencent-laravel
- Owner: serverless-components
- License: mit
- Created: 2019-12-24T07:27:01.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T21:01:31.000Z (about 2 years ago)
- Last Synced: 2024-10-29T00:38:54.040Z (4 months ago)
- Language: PHP
- Size: 252 KB
- Stars: 31
- Watchers: 7
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-serverless-framework - @serverless/tencent-laravel - (组件)
README
⚠️⚠️⚠️ 所有框架组件项目迁移到 [tencent-framework-components](https://github.com/serverless-components/tencent-framework-components).
[](http://serverless.com)
[](https://github.com/serverless-components/tencent-laravel/actions?query=workflow:Test)
腾讯云 [Laravel](https://github.com/laravel/laravel) Serverless Component, 支持 `Laravel >= 6.0`。
特性介绍：
- [x] **按需付费** - 按照请求的使用量进行收费，没有请求时无需付费
- [x] **"0"配置** - 只需要关心项目代码，之后部署即可，Serverless Framework 会搞定所有配置。
- [x] **极速部署** - 仅需几秒，部署你的整个 laravel 应用。
- [x] **便捷协作** - 通过云端的状态信息和部署日志，方便的进行多人协作开发。
- [x] **自定义域名** - 支持配置自定义域名及 HTTPS 访问
快速开始：
1. [**安装**](#1-安装)
2. [**创建**](#2-创建)
3. [**部署**](#3-部署)
4. [**配置**](#4-配置)
5. [**查看状态**](#5-查看状态)
6. [**移除**](#6-移除)
更多资源：
- [**架构说明**](#架构说明)
- [**账号配置**](#账号配置)
### 1. 安装
通过 npm 安装最新版本的 Serverless Framework
```bash
$ npm install -g serverless
```
### 2. 创建
通过如下命令和模板链接，快速创建一个 laravel 应用：
```bash
$ serverless init laravel-starter --name serverless-laravel
$ cd example
```
### 3. 部署
在 `serverless.yml` 文件所在的项目根目录，运行以下指令进行部署：
```bash
$ serverless deploy
```
部署时需要进行身份验证，如您的账号未 [登陆](https://cloud.tencent.com/login) 或 [注册](https://cloud.tencent.com/register) 腾讯云，您可以直接通过 `微信` 扫描命令行中的二维码进行授权登陆和注册。
> 注意: 如果希望查看更多部署过程的信息，可以通过`serverless deploy --debug` 命令查看部署过程中的实时日志信息。
### 4. 配置
laravel 组件支持 0 配置部署，也就是可以直接通过配置文件中的默认值进行部署。但你依然可以修改更多可选配置来进一步开发该 laravel 项目。
以下是 laravel 组件的 `serverless.yml`配置示例：
```yml
# serverless.yml
app: appDemo
stage: dev
component: laravel
name: laravelDemo
inputs:
src:
src: ./
functionName: laravelDemo
region: ap-guangzhou
runtime: Php7
apigatewayConf:
protocols:
- http
- https
environment: release
```
点此查看[全量配置及配置说明](https://github.com/serverless-components/tencent-laravel/tree/master/docs/configure.md)
当你根据该配置文件更新配置字段后，再次运行 `serverless deploy` 或者 `serverless` 就可以更新配置到云端。
### 5. 查看状态
在`serverless.yml`文件所在的目录下，通过如下命令查看部署状态：
```
$ serverless info
```
### 6. 移除
在`serverless.yml`文件所在的目录下，通过以下命令移除部署的 laravel 服务。移除后该组件会对应删除云上部署时所创建的所有相关资源。
```
$ serverless remove
```
和部署类似，支持通过 `serverless remove --debug` 命令查看移除过程中的实时日志信息。
## 架构说明
laravel 组件将在腾讯云账户中使用到如下 Serverless 服务：
- [x] **API 网关** - API 网关将会接收外部请求并且转发到 SCF 云函数中。
- [x] **SCF 云函数** - 云函数将承载 laravel.js 应用。
- [x] **CAM 访问控制** - 该组件会创建默认 CAM 角色用于授权访问关联资源。
- [x] **COS 对象存储** - 为确保上传速度和质量，云函数压缩并上传代码时，会默认将代码包存储在特定命名的 COS 桶中。
- [x] **SSL 证书服务** - 如果你在 yaml 文件中配置了 `apigatewayConf.customDomains` 字段，需要做自定义域名绑定并开启 HTTPS 时，也会用到证书管理服务和域名服务。Serverless Framework 会根据已经备案的域名自动申请并配置 SSL 证书。
## 账号配置
当前默认支持 CLI 扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 `.env` 文件
```console
$ touch .env # 腾讯云的配置信息
```
在 `.env` 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存
如果没有腾讯云账号，可以在此[注册新账号](https://cloud.tencent.com/register)。
如果已有腾讯云账号，可以在[API 密钥管理](https://console.cloud.tencent.com/cam/capi)中获取 `SecretId` 和`SecretKey`.
```
# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123
```
## License
MIT License
Copyright (c) 2020 Tencent Cloud, Inc.