快速开始

本地运行 Memos，创建第一个管理员用户，发布第一条笔记。

Memos 从一开始就设计为很快就能上手的样子。最快启动的方式是 Docker，附加一个 SQLite 和一个本地的数据卷。服务启动后，你可以对部署和存储进行加固。

先决条件

• 在你要安装 Memos 的机器上安装 Docker

1. 启动一个本地实例

docker run -d \
  --name memos \
  -p 5230:5230 \
  -v ~/.memos:/var/opt/memos \
  neosmemo/memos:stable

执行上述命令，你会得到：

• 当前主机暴露 5230 端口

• 一个持久化数据目录 ~/.memos

• 默认的数据库 SQLite

• 一个易于检查和更换的容器

如果你想要一个版本化的部署文件，你可以使用Docker Compose。如果你正在为 Memos 贡献代码，或者是需要一个自定义的构建版本，你可以从源代码构建。

2. 验证启动的实例

容器启动后，打开用户界面：

• 使用 Docker 启动：http://localhost:5230

• 使用二进制文件启动：http://localhost:8081

如果你想要先在终端中验证一下这个服务：

docker logs memos

3. 创建第一个管理员账号

第一个用户将会成为当前站点的管理员，可以对注册、认证、存储等进行全局配置。

推荐你先：

• 使用健壮的密码

• 如果当前实例要配置到反向代理商，先确认实例的 url。

• 决定是否开放注册，是保持禁用还是稍后开放。

• 决定是否允许公开笔记。

4. 创建你的第一条笔记

使用首页顶部的编辑器，尝试写一条笔记。

# 欢迎来到 Memos

这是我的第一条笔记

## 任务
- [x] 安装 Memos
- [ ] 写一条笔记

## 标签
尝试 #memos 和 #getting-started

## 代码
```ts
console.log("hello from memos");
```

下面是一些很有用的事，建议立即尝试一下：

• 将笔记的可见性设置为 私有、工作区 或者是 公开。

• 使用 - [] 添加一个备忘清单。

• 上传一个截屏或文件。

• 使用 #tagname 创建一个行内标签。

• 将重要的笔记置顶，让它始终可见。

5. 可见性

任何笔记都有下列其一可见性：

• 私有：只有你可以看到

• 工作区：当前实例上已验证的用户可以看到

• 公开：任何可以访问当前 URL 的用户都可以看到

对于一个私有的团队或个人的实例来说，禁用公开笔记是最安全的默认设置。

6. 浏览核心工作流

发过第一条笔记之后，接下来比较重要的工作流是：

• 编写 Markdown

• 标签

• 捷径

• 分享

• 附件

快捷键

快捷键	动作
Ctrl+Enter / Cmd+Enter	发送笔记
Escape	清空编辑器
Ctrl+K / Cmd+K	聚焦到搜索
/	聚焦到编辑器
Ctrl+B / Cmd+B	粗体文本
Ctrl+I / Cmd+I	斜体文本

初次运行的常见问题

• 如果 http://localhost:5230 没有成功加载，检查 docker logs memos。

• 如果数据目录不是可写的，检查 ~/.memos 的权限。

• 如果你运行在反向代理上，将 MEMOS_INSTANCE_URL 设置为公共 URL。