-
Notifications
You must be signed in to change notification settings - Fork 3
docs: Clarify the first FlatRun deployment #221
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # FlatRun | ||
|
|
||
| [English](README.md) | [Français](README.fr.md) | Español | [Português do Brasil](README.pt-BR.md) | [简体中文](README.zh-CN.md) | ||
|
|
||
| ## Ejecuta aplicaciones en contenedores en tus propios servidores | ||
|
|
||
| FlatRun permite desplegar, proteger, diagnosticar, automatizar y administrar | ||
| aplicaciones en contenedores desde un solo lugar. Ejecuta proyectos Docker | ||
| Compose estándar directamente y puede escalar cargas compatibles mediante | ||
| Docker Swarm o k3s. | ||
|
|
||
| Tus archivos Compose, configuraciones y datos permanecen en tus máquinas. | ||
| Puedes comenzar con un solo host Docker, conectar más servidores y activar la | ||
| orquestación cuando la carga lo necesite. | ||
|
|
||
| ## Primera aplicación | ||
|
|
||
| Instala FlatRun en Ubuntu o Debian: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/flatrun/installer/main/scripts/install.sh | sudo bash | ||
| ``` | ||
|
|
||
| Abre `http://<tu-servidor>:8080`, completa la configuración y crea un despliegue | ||
| desde una plantilla, una imagen o un archivo Compose. FlatRun configura los | ||
| contenedores, el enrutamiento y HTTPS desde el mismo panel. | ||
|
|
||
| Para trabajar desde el terminal: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/flatrun/cli/main/scripts/install.sh | sudo sh | ||
| flatrun profile add production --url https://panel.example.com --token your-api-key-here | ||
| flatrun profile use production | ||
| flatrun health | ||
| ``` | ||
|
|
||
| ## Qué aporta FlatRun | ||
|
|
||
| - Despliegues guardados como archivos y proyectos Docker Compose estándar. | ||
| - Planes que muestran los cambios antes de aplicarlos. | ||
| - Gestión de certificados, copias de seguridad, tareas programadas y acceso limitado. | ||
| - Métricas por contenedor exportables mediante OpenTelemetry y Prometheus. | ||
| - Gestión de varios servidores desde un solo panel. | ||
| - Escalado mediante Docker Swarm o k3s para cargas compatibles. | ||
| - Notificaciones relacionadas agrupadas en incidentes útiles. | ||
|
|
||
| El panel, el CLI, GitHub Actions y las integraciones externas utilizan la misma | ||
| API. La descripción OpenAPI exacta del agente instalado está disponible en | ||
| `/api/openapi.json`. | ||
|
|
||
| Consulta la [documentación completa](https://flatrun.dev/docs) o el | ||
| [README en inglés](README.md) para configuración, desarrollo y resolución de | ||
| problemas. | ||
|
|
||
| ## Licencia | ||
|
|
||
| Licencia MIT. Consulta [LICENSE](LICENSE). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # FlatRun | ||
|
|
||
| [English](README.md) | Français | [Español](README.es.md) | [Português do Brasil](README.pt-BR.md) | [简体中文](README.zh-CN.md) | ||
|
|
||
| ## Exécutez des applications conteneurisées sur vos propres serveurs | ||
|
|
||
| FlatRun permet de déployer, sécuriser, diagnostiquer, automatiser et gérer des | ||
| applications conteneurisées depuis une seule interface. Il exécute directement | ||
| des projets Docker Compose standards et peut faire évoluer les charges adaptées | ||
| avec Docker Swarm ou k3s. | ||
|
|
||
| Vos fichiers Compose, configurations et données restent sur vos machines. Vous | ||
| pouvez commencer avec un seul hôte Docker, puis connecter des serveurs et | ||
| activer l'orchestration lorsque la charge l'exige. | ||
|
|
||
| ## Première application | ||
|
|
||
| Installez FlatRun sur Ubuntu ou Debian : | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/flatrun/installer/main/scripts/install.sh | sudo bash | ||
| ``` | ||
|
|
||
| Ouvrez `http://<votre-serveur>:8080`, terminez la configuration, puis créez un | ||
| déploiement à partir d'un modèle, d'une image ou d'un fichier Compose. FlatRun | ||
| configure les conteneurs, le routage et HTTPS depuis le même tableau de bord. | ||
|
|
||
| Pour utiliser le terminal : | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/flatrun/cli/main/scripts/install.sh | sudo sh | ||
| flatrun profile add production --url https://panel.example.com --token your-api-key-here | ||
| flatrun profile use production | ||
| flatrun health | ||
| ``` | ||
|
|
||
| ## Ce que FlatRun apporte | ||
|
|
||
| - Des déploiements conservés comme fichiers et projets Docker Compose standards. | ||
| - Des plans qui montrent les changements avant leur application. | ||
| - La gestion des certificats, sauvegardes, tâches planifiées et accès limités. | ||
| - Des métriques par conteneur exportables avec OpenTelemetry et Prometheus. | ||
| - La gestion de plusieurs serveurs depuis un seul tableau de bord. | ||
| - La mise à l'échelle avec Docker Swarm ou k3s pour les charges compatibles. | ||
| - Des notifications regroupées en incidents utiles. | ||
|
|
||
| Le tableau de bord, le CLI, GitHub Actions et les intégrations externes utilisent | ||
| la même API. La description OpenAPI exacte de l'agent installé est disponible à | ||
| l'adresse `/api/openapi.json`. | ||
|
|
||
| Consultez la [documentation complète](https://flatrun.dev/docs) ou le | ||
| [README anglais](README.md) pour la configuration, le développement et le | ||
| dépannage. | ||
|
|
||
| ## Licence | ||
|
|
||
| Licence MIT. Consultez [LICENSE](LICENSE). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # FlatRun | ||
|
|
||
| [English](README.md) | [Français](README.fr.md) | [Español](README.es.md) | Português do Brasil | [简体中文](README.zh-CN.md) | ||
|
|
||
| ## Execute aplicações em contêineres nos seus próprios servidores | ||
|
|
||
| O FlatRun permite implantar, proteger, diagnosticar, automatizar e gerenciar | ||
| aplicações em contêineres em um só lugar. Ele executa projetos Docker Compose | ||
| padrão diretamente e pode escalar cargas compatíveis com Docker Swarm ou k3s. | ||
|
|
||
| Seus arquivos Compose, configurações e dados permanecem nas suas máquinas. | ||
| Comece com um único host Docker, conecte outros servidores e ative a | ||
| orquestração quando a carga precisar. | ||
|
|
||
| ## Primeira aplicação | ||
|
|
||
| Instale o FlatRun no Ubuntu ou Debian: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/flatrun/installer/main/scripts/install.sh | sudo bash | ||
| ``` | ||
|
|
||
| Abra `http://<seu-servidor>:8080`, conclua a configuração e crie uma implantação | ||
| a partir de um modelo, uma imagem ou um arquivo Compose. O FlatRun configura os | ||
| contêineres, o roteamento e o HTTPS no mesmo painel. | ||
|
|
||
| Para trabalhar pelo terminal: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/flatrun/cli/main/scripts/install.sh | sudo sh | ||
| flatrun profile add production --url https://panel.example.com --token your-api-key-here | ||
| flatrun profile use production | ||
| flatrun health | ||
| ``` | ||
|
|
||
| ## O que o FlatRun oferece | ||
|
|
||
| - Implantações mantidas como arquivos e projetos Docker Compose padrão. | ||
| - Planos que mostram as mudanças antes da aplicação. | ||
| - Gestão de certificados, backups, tarefas agendadas e acesso limitado. | ||
| - Métricas por contêiner exportáveis com OpenTelemetry e Prometheus. | ||
| - Gestão de vários servidores em um único painel. | ||
| - Escalabilidade com Docker Swarm ou k3s para cargas compatíveis. | ||
| - Notificações relacionadas agrupadas em incidentes úteis. | ||
|
|
||
| O painel, o CLI, o GitHub Actions e as integrações externas usam a mesma API. A | ||
| descrição OpenAPI exata do agente instalado está disponível em | ||
| `/api/openapi.json`. | ||
|
|
||
| Consulte a [documentação completa](https://flatrun.dev/docs) ou o | ||
| [README em inglês](README.md) para configuração, desenvolvimento e solução de | ||
| problemas. | ||
|
|
||
| ## Licença | ||
|
|
||
| Licença MIT. Consulte [LICENSE](LICENSE). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # FlatRun | ||
|
|
||
| [English](README.md) | [Français](README.fr.md) | [Español](README.es.md) | [Português do Brasil](README.pt-BR.md) | 简体中文 | ||
|
|
||
| ## 在自己的服务器上运行容器应用 | ||
|
|
||
| FlatRun 让你从一个位置部署、保护、诊断、自动化和管理容器应用。它直接运行标准 | ||
| Docker Compose 项目,也可以通过 Docker Swarm 或 k3s 扩展符合条件的工作负载。 | ||
|
|
||
| Compose 文件、配置和数据始终保留在你的机器上。你可以从一台 Docker 主机开始, | ||
| 在需要时连接更多服务器并启用编排。 | ||
|
|
||
| ## 部署第一个应用 | ||
|
|
||
| 在 Ubuntu 或 Debian 服务器上安装 FlatRun: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/flatrun/installer/main/scripts/install.sh | sudo bash | ||
| ``` | ||
|
|
||
| 打开 `http://<你的服务器>:8080`,完成设置,然后通过模板、镜像或 Compose 文件创建 | ||
| 部署。FlatRun 在同一个控制面板中配置容器、路由和 HTTPS。 | ||
|
|
||
| 如需使用终端: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/flatrun/cli/main/scripts/install.sh | sudo sh | ||
| flatrun profile add production --url https://panel.example.com --token your-api-key-here | ||
| flatrun profile use production | ||
| flatrun health | ||
| ``` | ||
|
|
||
| ## FlatRun 提供什么 | ||
|
|
||
| - 部署保持为普通文件和标准 Docker Compose 项目。 | ||
| - 在应用变更前查看计划。 | ||
| - 管理证书、备份、计划任务和受限访问。 | ||
| - 使用 OpenTelemetry 和 Prometheus 导出每个容器的指标。 | ||
| - 从一个控制面板管理多台服务器。 | ||
| - 使用 Docker Swarm 或 k3s 扩展符合条件的工作负载。 | ||
| - 将相关通知合并为有用的事件。 | ||
|
|
||
| 控制面板、CLI、GitHub Actions 和外部集成都使用同一个 API。已安装代理的准确 | ||
| OpenAPI 描述位于 `/api/openapi.json`。 | ||
|
|
||
| 配置、开发和故障排除请参阅[完整文档](https://flatrun.dev/docs)或 | ||
| [英文 README](README.md)。 | ||
|
|
||
| ## 许可证 | ||
|
|
||
| MIT 许可证。请参阅 [LICENSE](LICENSE)。 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with the agent installation command and to ensure the installer script executes in the intended environment, use
bashinstead ofsh. Additionally, using a placeholder that reflects the default Agent API port (8090) makes the first-time setup clearer for users who have just followed the initial server installation steps.