1 pub mod api_routes_http;
2 pub mod code_migrations;
3 #[cfg(feature = "prometheus-metrics")]
4 pub mod prometheus_metrics;
5 pub mod root_span_builder;
6 pub mod scheduled_tasks;
7 #[cfg(feature = "console")]
10 use crate::{code_migrations::run_advanced_migrations, root_span_builder::QuieterRootSpanBuilder};
11 use activitypub_federation::config::{FederationConfig, FederationMiddleware};
14 middleware::{self, ErrorHandlers},
20 use lemmy_api_common::{
21 context::LemmyContext,
22 lemmy_db_views::structs::SiteView,
23 request::build_user_agent,
24 send_activity::{ActivityChannel, MATCH_OUTGOING_ACTIVITIES},
26 check_private_instance_and_federation_enabled,
27 local_site_rate_limit_to_rate_limit_config,
31 activities::{handle_outgoing_activities, match_outgoing_activities},
33 FEDERATION_HTTP_FETCH_LIMIT,
35 use lemmy_db_schema::{
36 source::secret::Secret,
37 utils::{build_db_pool, get_database_url, run_migrations},
39 use lemmy_routes::{feeds, images, nodeinfo, webfinger};
42 rate_limit::RateLimitCell,
43 response::jsonify_plain_text_errors,
45 SYNCHRONOUS_FEDERATION,
48 use reqwest_middleware::ClientBuilder;
49 use reqwest_tracing::TracingMiddleware;
50 use std::{env, thread, time::Duration};
51 use tracing::subscriber::set_global_default;
52 use tracing_actix_web::TracingLogger;
53 use tracing_error::ErrorLayer;
54 use tracing_log::LogTracer;
55 use tracing_subscriber::{filter::Targets, layer::SubscriberExt, Layer, Registry};
57 #[cfg(feature = "prometheus-metrics")]
59 actix_web_prom::PrometheusMetricsBuilder,
60 prometheus::default_registry,
61 prometheus_metrics::serve_prometheus,
64 /// Max timeout for http requests
65 pub(crate) const REQWEST_TIMEOUT: Duration = Duration::from_secs(10);
67 /// Placing the main function in lib.rs allows other crates to import it and embed Lemmy
68 pub async fn start_lemmy_server() -> Result<(), LemmyError> {
69 let args: Vec<String> = env::args().collect();
71 let scheduled_tasks_enabled = args.get(1) != Some(&"--disable-scheduled-tasks".to_string());
73 let settings = SETTINGS.to_owned();
75 // Run the DB migrations
76 let db_url = get_database_url(Some(&settings));
77 run_migrations(&db_url);
79 // Set up the connection pool
80 let pool = build_db_pool(&settings).await?;
82 // Run the Code-required migrations
83 run_advanced_migrations(&mut (&pool).into(), &settings).await?;
85 // Initialize the secrets
86 let secret = Secret::init(&mut (&pool).into())
88 .expect("Couldn't initialize secrets.");
90 // Make sure the local site is set up.
91 let site_view = SiteView::read_local(&mut (&pool).into())
93 .expect("local site not set up");
94 let local_site = site_view.local_site;
95 let federation_enabled = local_site.federation_enabled;
97 if federation_enabled {
98 println!("federation enabled, host is {}", &settings.hostname);
101 check_private_instance_and_federation_enabled(&local_site)?;
103 // Set up the rate limiter
104 let rate_limit_config =
105 local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
106 let rate_limit_cell = RateLimitCell::new(rate_limit_config).await;
109 "Starting http server at {}:{}",
110 settings.bind, settings.port
113 let user_agent = build_user_agent(&settings);
114 let reqwest_client = Client::builder()
115 .user_agent(user_agent.clone())
116 .timeout(REQWEST_TIMEOUT)
117 .connect_timeout(REQWEST_TIMEOUT)
120 let client = ClientBuilder::new(reqwest_client.clone())
121 .with(TracingMiddleware::default())
124 // Pictrs cannot use the retry middleware
125 let pictrs_client = ClientBuilder::new(reqwest_client.clone())
126 .with(TracingMiddleware::default())
129 let context = LemmyContext::create(
133 rate_limit_cell.clone(),
136 if scheduled_tasks_enabled {
137 // Schedules various cleanup tasks for the DB
139 let context = context.clone();
141 scheduled_tasks::setup(db_url, user_agent, context)
142 .expect("Couldn't set up scheduled_tasks");
147 #[cfg(feature = "prometheus-metrics")]
148 serve_prometheus(settings.prometheus.as_ref(), context.clone());
150 let settings_bind = settings.clone();
152 let federation_config = FederationConfig::builder()
153 .domain(settings.hostname.clone())
154 .app_data(context.clone())
155 .client(client.clone())
156 .http_fetch_limit(FEDERATION_HTTP_FETCH_LIMIT)
157 .worker_count(settings.worker_count)
158 .retry_count(settings.retry_count)
159 .debug(*SYNCHRONOUS_FEDERATION)
160 .http_signature_compat(true)
161 .url_verifier(Box::new(VerifyUrlData(context.inner_pool().clone())))
165 // this must come before the HttpServer creation
166 // creates a middleware that populates http metrics for each path, method, and status code
167 #[cfg(feature = "prometheus-metrics")]
168 let prom_api_metrics = PrometheusMetricsBuilder::new("lemmy_api")
169 .registry(default_registry().clone())
171 .expect("Should always be buildable");
173 MATCH_OUTGOING_ACTIVITIES
174 .set(Box::new(move |d, c| {
175 Box::pin(match_outgoing_activities(d, c))
177 .expect("set function pointer");
178 let request_data = federation_config.to_request_data();
179 let outgoing_activities_task = tokio::task::spawn(handle_outgoing_activities(request_data));
181 // Create Http server with websocket support
182 HttpServer::new(move || {
183 let cors_origin = env::var("LEMMY_CORS_ORIGIN");
184 let cors_config = match (cors_origin, cfg!(debug_assertions)) {
185 (Ok(origin), false) => Cors::default()
186 .allowed_origin(&origin)
187 .allowed_origin(&settings.get_protocol_and_hostname()),
197 .wrap(middleware::Logger::new(
198 // This is the default log format save for the usage of %{r}a over %a to guarantee to record the client's (forwarded) IP and not the last peer address, since the latter is frequently just a reverse proxy
199 "%{r}a '%r' %s %b '%{Referer}i' '%{User-Agent}i' %T",
201 .wrap(middleware::Compress::default())
203 .wrap(TracingLogger::<QuieterRootSpanBuilder>::new())
204 .wrap(ErrorHandlers::new().default_handler(jsonify_plain_text_errors))
205 .app_data(Data::new(context.clone()))
206 .app_data(Data::new(rate_limit_cell.clone()))
207 .wrap(FederationMiddleware::new(federation_config.clone()));
209 #[cfg(feature = "prometheus-metrics")]
210 let app = app.wrap(prom_api_metrics.clone());
214 .configure(|cfg| api_routes_http::config(cfg, rate_limit_cell))
216 if federation_enabled {
217 lemmy_apub::http::routes::config(cfg);
218 webfinger::config(cfg);
221 .configure(feeds::config)
222 .configure(|cfg| images::config(cfg, pictrs_client.clone(), rate_limit_cell))
223 .configure(nodeinfo::config)
225 .bind((settings_bind.bind, settings_bind.port))?
229 // Wait for outgoing apub sends to complete
230 ActivityChannel::close(outgoing_activities_task).await?;
235 pub fn init_logging(opentelemetry_url: &Option<Url>) -> Result<(), LemmyError> {
238 let log_description = std::env::var("RUST_LOG").unwrap_or_else(|_| "info".into());
240 let targets = log_description
243 .parse::<Targets>()?;
246 #[cfg(feature = "json-log")]
247 let layer = tracing_subscriber::fmt::layer().json();
248 #[cfg(not(feature = "json-log"))]
249 let layer = tracing_subscriber::fmt::layer();
251 layer.with_filter(targets.clone())
254 let subscriber = Registry::default()
256 .with(ErrorLayer::default());
258 if let Some(_url) = opentelemetry_url {
259 #[cfg(feature = "console")]
260 telemetry::init_tracing(_url.as_ref(), subscriber, targets)?;
261 #[cfg(not(feature = "console"))]
262 tracing::error!("Feature `console` must be enabled for opentelemetry tracing");
264 set_global_default(subscriber)?;