2 Commits
Author SHA1 Message Date
David Burke 4cfe84da42 Fix heroku link 2021-02-15 12:48:49 -05:00
Emily Jensen 5b1d882ac9 update readme 2021-02-05 15:40:52 -05:00
17 changed files with 29 additions and 158 deletions

No files matched your search

+16 -29
View File
@@ -14,37 +14,24 @@ spec:
value: ${glitchtip-redis.DATABASE_URL}
name: glitchtip
services:
- name: web
image:
registry_type: DOCKER_HUB
registry: glitchtip
repository: glitchtip
tag: latest # Consider pinning to a specific version
instance_count: 1
instance_size_slug: basic-xxs
envs:
- key: SERVER_ROLE
value: "web"
- dockerfile_path: Dockerfile
git:
branch: master
repo_clone_url: https://gitlab.com/glitchtip/glitchtip-app-platform.git
name: glitchtip-web
workers:
- name: worker
image:
registry_type: DOCKER_HUB
registry: glitchtip
repository: glitchtip
tag: latest # Consider pinning to a specific version
instance_count: 1 # Keep this 1, add worker (no beat) for more
instance_size_slug: basic-xxs
envs:
- key: SERVER_ROLE
value: "worker_with_beat"
- dockerfile_path: Dockerfile
git:
branch: master
repo_clone_url: https://gitlab.com/glitchtip/glitchtip-app-platform.git
name: glitchtip-worker
run_command: ./bin/run-celery-with-beat.sh
jobs:
- image:
registry_type: DOCKER_HUB
registry: glitchtip
repository: glitchtip
tag: latest # Consider pinning to a specific version
name: migrate
- dockerfile_path: Dockerfile
git:
branch: master
repo_clone_url: https://gitlab.com/glitchtip/glitchtip-app-platform.git
name: glitchtip-migrate
run_command: ./manage.py migrate
databases:
- name: glitchtip-db
-1
View File
@@ -1 +0,0 @@
.gitea/CODEOWNERS linguist-detectable=false
-3
View File
@@ -1,3 +0,0 @@
# Pull requests request review from the eligible staff team(s).
# One approval from either an Admin or Developer satisfies branch protection.
* @trueog/Admins @trueog/Developers
View File
Whitespace-only changes.
View File
Whitespace-only changes.
-24
View File
@@ -1,24 +0,0 @@
<!--
Review this checklist before submitting.
-->
- [ ] **Is this a Help Request?** GitLab issues are for bug reports and feature requests. For configuration help or "how-to" questions, please use [Gitter](https://app.gitter.im/#/room/#GlitchTip_community:gitter.im).
- [ ] **Security Scanners:** Do not open issues for automated security scanner results. We use Renovate and internal tools. If you want to fix a vulnerability, please open a Merge Request.
- [ ] **Reproduction:** Document detailed steps to reproduce the issue on the latest version of GlitchTip. If possible, verify if it happens on https://app.glitchtip.com.
- [ ] **Expectations:** GlitchTip is open source and community-supported. Issues are triaged based on severity and available resources.
- [ ] **Prioritization:** Priority is given to issues that include a proposed solution (Merge Request) or are reported by [License holders](https://glitchtip.com/pricing/).
## Description
What did you expect to happen? What happened instead?
## Steps to Reproduce
1.
2.
3.
## Proposed Solution / Resolution
GlitchTip relies on contributions to improve. How can you help resolve this issue?
- [ ] I will investigate and submit a Merge Request.
- [ ] I have an active [License](https://glitchtip.com) (Enterprise or Individual) or donate.
- [ ] I am reporting this for the community. (I understand a fix depends on maintainer availability).
@@ -1,5 +0,0 @@
## Summary
## Checklist
- [ ] I am respecting Sentry's proprietary Business Source License (BSL) by implementing code in a clean room environment. I have not read any BSL Sentry code. It is OK to read MIT licensed code.
-6
View File
@@ -1,6 +0,0 @@
[submodule "glitchtip-frontend"]
path = glitchtip-frontend
url = https://git.trueog.net/trueog/glitchtip-frontend
[submodule "glitchtip-backend"]
path = glitchtip-backend
url = https://git.trueog.net/trueog/glitchtip-backend
-7
View File
@@ -1,7 +0,0 @@
# How to contribute
You are encouraged to submit issues and merge requests. Submit only feature requests that you intend to contribute to. Do not submit feature requests for niche features such as 3rd party integrations that you do not intend to build (or fund).
A good issue includes reproducible steps for bugs. Clear use cases for feature requests.
This repository is for meta issues not specifically related to our [Python Backend](https://gitlab.com/glitchtip/glitchtip-backend/-/blob/master/CONTRIBUTING.md) nor [TypeScript Frontend](https://gitlab.com/glitchtip/glitchtip-frontend/-/blob/master/CONTRIBUTING.md).
-21
View File
@@ -1,21 +0,0 @@
MIT License
Copyright (c) 2023 David Burke
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+1
View File
@@ -0,0 +1 @@
web: ./bin/run-uwsgi.sh
+6 -32
View File
@@ -1,23 +1,10 @@
# GlitchTip
This is a meta repo for general issue tracking, wiki, and deployment information.
- [Django Backend](https://gitlab.com/glitchtip/glitchtip-backend)
- [Angular Frontend](https://gitlab.com/glitchtip/glitchtip-frontend)
- [Documentation](https://glitchtip.com/documentation)
- [Wiki](https://gitlab.com/glitchtip/glitchtip/-/wikis/home)
# Installing GlitchTip on DigitalOcean App Platform
GlitchTip on DO App Platform consists of a web, worker, migration job, postgres database, and redis. Start by clicking the following button. Note this link acts as a referral and helps fund GlitchTip.
[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://gitlab.com/glitchtip/glitchtip/tree/master&refcode=7e90b8fb37f8)
[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://gitlab.com/glitchtip/glitchtip-app-platform/tree/master&refcode=7e90b8fb37f8)
Leave environment variables blank and click next. Pick the basic or pro plan. One 512 MB RAM | 1 vCPU is fine to start with. Click Launch. Now copy [app-platform.yaml](app-platform.yaml) to your local computer. Edit the following
## Name and region
This can be anything. We default to "glitchtip" and "nyc".
Leave environment variables blank and click next. Pick the basic or pro plan. One 512 MB RAM | 1 vCPU is fine to start with. Click Launch. Now copy [app-platform.yaml](https://gitlab.com/glitchtip/glitchtip-app-platform/-/blob/master/app-platform.yaml) to your local computer. Edit the following
## Environment Variables
@@ -25,6 +12,10 @@ At a minimum, set the SECRET_KEY to a random string of letters.
For more information on configuration settings see our install [docs](https://glitchtip.com/documentation/install#Configuration).
## Name Variable
The name variable is set to "glitchtip". You can change this, as long as it doesn't match any other app names in your Digital Ocean account.
## Redis
GlitchTip requires Redis for sending notification, managing events, and more. Go to https://cloud.digitalocean.com/databases/ and create a new redis database. For almost all size instances, the 1 GB RAM | 1 vCPU instance is sufficient. Enter your redis database's name in the glitchtip-redis section. Let's assume it's named "glitchtip-redis". At the time of this writing, both "name" and "cluster_name" must be the same value.
@@ -57,20 +48,3 @@ If you haven't already, you'll need to set up email via environment variables.
## Upgrading GlitchTip
By default, the docker image tag is "latest". Click Deploy to upgrade to the latest GlitchTip docker image.
# Deploy on Heroku
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/burke-software/GlitchTip)
1. Deploy the app by clicking the above link and following the prompt.
2. SECRET_KEY is generated for you. Other environment variables must be entered in the app's settings. See configuration [docs](https://glitchtip.com/documentation/install#Configuration).
## Production considerations
Consider upgrading your Postgres and web dyno plan for production usage.
Most users do not need additional workers. However if you do, create a third dyno typed called extra_worker. Set the run command to `./bin/run-celery.sh`. Do not increase the "worker" dyno count because this these run with an embedded Celery beat scheduler.
## Upgrading GlitchTip
By default, the docker image tag is "latest". Click Deploy to upgrade to the latest GlitchTip docker image.
+3 -3
View File
@@ -16,20 +16,20 @@ services:
- dockerfile_path: Dockerfile
git:
branch: master
repo_clone_url: https://gitlab.com/glitchtip/glitchtip.git
repo_clone_url: https://gitlab.com/glitchtip/glitchtip-app-platform.git
name: glitchtip-web
workers:
- dockerfile_path: Dockerfile
git:
branch: master
repo_clone_url: https://gitlab.com/glitchtip/glitchtip.git
repo_clone_url: https://gitlab.com/glitchtip/glitchtip-app-platform.git
name: glitchtip-worker
run_command: ./bin/run-celery-with-beat.sh
jobs:
- dockerfile_path: Dockerfile
git:
branch: master
repo_clone_url: https://gitlab.com/glitchtip/glitchtip.git
repo_clone_url: https://gitlab.com/glitchtip/glitchtip-app-platform.git
name: glitchtip-migrate
run_command: ./manage.py migrate
databases:
+3 -18
View File
@@ -3,31 +3,16 @@
"description": "An open source reimplementation of Sentry error tracking platform",
"repository": "https://gitlab.com/glitchtip/glitchtip.git",
"logo": "https://glitchtip.com/assets/logo-again.svg",
"website": "https://glitchtip.com",
"keywords": ["python", "django"],
"formation": {
"web": {
"quantity": 1,
"size": "free"
},
"worker": {
"quantity": 1,
"size": "free"
}
},
"scripts": {
"postdeploy": "./manage.py migrate"
},
"env": {
"SECRET_KEY": {
"description": "Django Secret Key.",
"generator": "secret"
}
},
"image": "glitchtip/glitchtip",
"stack": "container",
"addons": [
"heroku-postgresql",
"heroku-redis"
]
}
"image": "glitchtip/glitchtip"
}
-7
View File
@@ -1,7 +0,0 @@
build:
docker:
web: Dockerfile
worker: Dockerfile
run:
web: ./bin/run-uwsgi.sh
worker: ./bin/run-celery-with-beat.sh